From 14e501ffa8aca33fd37f4772901fedf4d60696cc Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Mon, 18 Jul 2022 17:35:06 +0200 Subject: [PATCH] [Console] Improve the description of command options --- console/input.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/console/input.rst b/console/input.rst index 99c02f17607..c48968c81fc 100644 --- a/console/input.rst +++ b/console/input.rst @@ -134,10 +134,17 @@ how many times in a row the message should be printed:: $this // ... ->addOption( + // this is the name that users must type to pass this option (e.g. --iterations=5) 'iterations', + // this is the optional shortcut of the option name, which usually is just a letter + // (e.g. `i`, so users pass it as `-i`); use it for commonly used options + // or options with long names null, + // this is the type of option (e.g. requires a value, can be passed more than once, etc.) InputOption::VALUE_REQUIRED, + // the option description displayed when showing the command help 'How many times should the message be printed?', + // the default value of the option (for those which allow to pass values) 1 ) ;