diff --git a/src/Symfony/Component/Console/Descriptor/MarkdownDescriptor.php b/src/Symfony/Component/Console/Descriptor/MarkdownDescriptor.php index 2eb9944d6213c..b893d7ea0d9a8 100644 --- a/src/Symfony/Component/Console/Descriptor/MarkdownDescriptor.php +++ b/src/Symfony/Component/Console/Descriptor/MarkdownDescriptor.php @@ -32,11 +32,10 @@ class MarkdownDescriptor extends Descriptor protected function describeInputArgument(InputArgument $argument, array $options = array()) { $this->write( - '**'.$argument->getName().':**'."\n\n" - .'* Name: '.($argument->getName() ?: '')."\n" + '#### `'.($argument->getName() ?: '')."`\n\n" + .($argument->getDescription() ? preg_replace('/\s*[\r\n]\s*/', "\n", $argument->getDescription())."\n\n" : '') .'* Is required: '.($argument->isRequired() ? 'yes' : 'no')."\n" .'* Is array: '.($argument->isArray() ? 'yes' : 'no')."\n" - .'* Description: '.preg_replace('/\s*[\r\n]\s*/', "\n ", $argument->getDescription() ?: '')."\n" .'* Default: `'.str_replace("\n", '', var_export($argument->getDefault(), true)).'`' ); } @@ -46,14 +45,17 @@ protected function describeInputArgument(InputArgument $argument, array $options */ protected function describeInputOption(InputOption $option, array $options = array()) { + $name = '--'.$option->getName(); + if ($option->getShortcut()) { + $name .= '|-'.implode('|-', explode('|', $option->getShortcut())).''; + } + $this->write( - '**'.$option->getName().':**'."\n\n" - .'* Name: `--'.$option->getName().'`'."\n" - .'* Shortcut: '.($option->getShortcut() ? '`-'.implode('|-', explode('|', $option->getShortcut())).'`' : '')."\n" + '#### `'.$name.'`'."\n\n" + .($option->getDescription() ? preg_replace('/\s*[\r\n]\s*/', "\n", $option->getDescription())."\n\n" : '') .'* Accept value: '.($option->acceptValue() ? 'yes' : 'no')."\n" .'* Is value required: '.($option->isValueRequired() ? 'yes' : 'no')."\n" .'* Is multiple: '.($option->isArray() ? 'yes' : 'no')."\n" - .'* Description: '.preg_replace('/\s*[\r\n]\s*/', "\n ", $option->getDescription() ?: '')."\n" .'* Default: `'.str_replace("\n", '', var_export($option->getDefault(), true)).'`' ); } @@ -64,7 +66,7 @@ protected function describeInputOption(InputOption $option, array $options = arr protected function describeInputDefinition(InputDefinition $definition, array $options = array()) { if ($showArguments = count($definition->getArguments()) > 0) { - $this->write('### Arguments:'); + $this->write('### Arguments'); foreach ($definition->getArguments() as $argument) { $this->write("\n\n"); $this->write($this->describeInputArgument($argument)); @@ -76,7 +78,7 @@ protected function describeInputDefinition(InputDefinition $definition, array $o $this->write("\n\n"); } - $this->write('### Options:'); + $this->write('### Options'); foreach ($definition->getOptions() as $option) { $this->write("\n\n"); $this->write($this->describeInputOption($option)); @@ -93,12 +95,12 @@ protected function describeCommand(Command $command, array $options = array()) $command->mergeApplicationDefinition(false); $this->write( - $command->getName()."\n" - .str_repeat('-', strlen($command->getName()))."\n\n" - .'* Description: '.($command->getDescription() ?: '')."\n" - .'* Usage:'."\n\n" + '`'.$command->getName()."`\n" + .str_repeat('-', strlen($command->getName()) + 2)."\n\n" + .($command->getDescription() ? $command->getDescription()."\n\n" : '') + .'### Usage'."\n\n" .array_reduce(array_merge(array($command->getSynopsis()), $command->getAliases(), $command->getUsages()), function ($carry, $usage) { - return $carry.' * `'.$usage.'`'."\n"; + return $carry.'* `'.$usage.'`'."\n"; }) ); @@ -121,7 +123,7 @@ protected function describeApplication(Application $application, array $options $describedNamespace = isset($options['namespace']) ? $options['namespace'] : null; $description = new ApplicationDescription($application, $describedNamespace); - $this->write($application->getName()."\n".str_repeat('=', strlen($application->getName()))); + $this->write($application->getLongVersion()."\n".str_repeat('=', strlen($application->getLongVersion()))); foreach ($description->getNamespaces() as $namespace) { if (ApplicationDescription::GLOBAL_NAMESPACE !== $namespace['id']) { @@ -131,7 +133,7 @@ protected function describeApplication(Application $application, array $options $this->write("\n\n"); $this->write(implode("\n", array_map(function ($commandName) { - return '* '.$commandName; + return '* `'.$commandName.'`'; }, $namespace['commands']))); } diff --git a/src/Symfony/Component/Console/Tests/Fixtures/application_1.md b/src/Symfony/Component/Console/Tests/Fixtures/application_1.md index f1d88c5b7d1ab..82f426d638d33 100644 --- a/src/Symfony/Component/Console/Tests/Fixtures/application_1.md +++ b/src/Symfony/Component/Console/Tests/Fixtures/application_1.md @@ -1,16 +1,17 @@ -UNKNOWN -======= +Console Tool +============ -* help -* list +* `help` +* `list` -help ----- +`help` +------ -* Description: Displays help for a command -* Usage: +Displays help for a command - * `help [--format FORMAT] [--raw] [--] []` +### Usage + +* `help [--format FORMAT] [--raw] [--] []` The help command displays help for a given command: @@ -22,115 +23,107 @@ You can also output the help in other formats by using the --formatlist command. -### Arguments: +### Arguments + +#### `command_name` -**command_name:** +The command name -* Name: command_name * Is required: no * Is array: no -* Description: The command name * Default: `'help'` -### Options: +### Options -**format:** +#### `--format` + +The output format (txt, xml, json, or md) -* Name: `--format` -* Shortcut: * Accept value: yes * Is value required: yes * Is multiple: no -* Description: The output format (txt, xml, json, or md) * Default: `'txt'` -**raw:** +#### `--raw` + +To output raw command help -* Name: `--raw` -* Shortcut: * Accept value: no * Is value required: no * Is multiple: no -* Description: To output raw command help * Default: `false` -**help:** +#### `--help|-h` + +Display this help message -* Name: `--help` -* Shortcut: `-h` * Accept value: no * Is value required: no * Is multiple: no -* Description: Display this help message * Default: `false` -**quiet:** +#### `--quiet|-q` + +Do not output any message -* Name: `--quiet` -* Shortcut: `-q` * Accept value: no * Is value required: no * Is multiple: no -* Description: Do not output any message * Default: `false` -**verbose:** +#### `--verbose|-v|-vv|-vvv` + +Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug -* Name: `--verbose` -* Shortcut: `-v|-vv|-vvv` * Accept value: no * Is value required: no * Is multiple: no -* Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug * Default: `false` -**version:** +#### `--version|-V` + +Display this application version -* Name: `--version` -* Shortcut: `-V` * Accept value: no * Is value required: no * Is multiple: no -* Description: Display this application version * Default: `false` -**ansi:** +#### `--ansi` + +Force ANSI output -* Name: `--ansi` -* Shortcut: * Accept value: no * Is value required: no * Is multiple: no -* Description: Force ANSI output * Default: `false` -**no-ansi:** +#### `--no-ansi` + +Disable ANSI output -* Name: `--no-ansi` -* Shortcut: * Accept value: no * Is value required: no * Is multiple: no -* Description: Disable ANSI output * Default: `false` -**no-interaction:** +#### `--no-interaction|-n` + +Do not ask any interactive question -* Name: `--no-interaction` -* Shortcut: `-n` * Accept value: no * Is value required: no * Is multiple: no -* Description: Do not ask any interactive question * Default: `false` -list ----- +`list` +------ + +Lists commands -* Description: Lists commands -* Usage: +### Usage - * `list [--raw] [--format FORMAT] [--] []` +* `list [--raw] [--format FORMAT] [--] []` The list command lists all commands: @@ -148,34 +141,32 @@ It's also possible to get raw list of commands (useful for embedding command run php app/console list --raw -### Arguments: +### Arguments -**namespace:** +#### `namespace` + +The namespace name -* Name: namespace * Is required: no * Is array: no -* Description: The namespace name * Default: `NULL` -### Options: +### Options + +#### `--raw` -**raw:** +To output raw command list -* Name: `--raw` -* Shortcut: * Accept value: no * Is value required: no * Is multiple: no -* Description: To output raw command list * Default: `false` -**format:** +#### `--format` + +The output format (txt, xml, json, or md) -* Name: `--format` -* Shortcut: * Accept value: yes * Is value required: yes * Is multiple: no -* Description: The output format (txt, xml, json, or md) * Default: `'txt'` diff --git a/src/Symfony/Component/Console/Tests/Fixtures/application_2.md b/src/Symfony/Component/Console/Tests/Fixtures/application_2.md index 63b2d9ab422e1..68c8b0be1c091 100644 --- a/src/Symfony/Component/Console/Tests/Fixtures/application_2.md +++ b/src/Symfony/Component/Console/Tests/Fixtures/application_2.md @@ -1,23 +1,24 @@ -My Symfony application -====================== +My Symfony application v1.0 +======================================== -* alias1 -* alias2 -* help -* list +* `alias1` +* `alias2` +* `help` +* `list` **descriptor:** -* descriptor:command1 -* descriptor:command2 +* `descriptor:command1` +* `descriptor:command2` -help ----- +`help` +------ -* Description: Displays help for a command -* Usage: +Displays help for a command - * `help [--format FORMAT] [--raw] [--] []` +### Usage + +* `help [--format FORMAT] [--raw] [--] []` The help command displays help for a given command: @@ -29,115 +30,107 @@ You can also output the help in other formats by using the --formatlist command. -### Arguments: +### Arguments + +#### `command_name` -**command_name:** +The command name -* Name: command_name * Is required: no * Is array: no -* Description: The command name * Default: `'help'` -### Options: +### Options -**format:** +#### `--format` + +The output format (txt, xml, json, or md) -* Name: `--format` -* Shortcut: * Accept value: yes * Is value required: yes * Is multiple: no -* Description: The output format (txt, xml, json, or md) * Default: `'txt'` -**raw:** +#### `--raw` + +To output raw command help -* Name: `--raw` -* Shortcut: * Accept value: no * Is value required: no * Is multiple: no -* Description: To output raw command help * Default: `false` -**help:** +#### `--help|-h` + +Display this help message -* Name: `--help` -* Shortcut: `-h` * Accept value: no * Is value required: no * Is multiple: no -* Description: Display this help message * Default: `false` -**quiet:** +#### `--quiet|-q` + +Do not output any message -* Name: `--quiet` -* Shortcut: `-q` * Accept value: no * Is value required: no * Is multiple: no -* Description: Do not output any message * Default: `false` -**verbose:** +#### `--verbose|-v|-vv|-vvv` + +Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug -* Name: `--verbose` -* Shortcut: `-v|-vv|-vvv` * Accept value: no * Is value required: no * Is multiple: no -* Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug * Default: `false` -**version:** +#### `--version|-V` + +Display this application version -* Name: `--version` -* Shortcut: `-V` * Accept value: no * Is value required: no * Is multiple: no -* Description: Display this application version * Default: `false` -**ansi:** +#### `--ansi` + +Force ANSI output -* Name: `--ansi` -* Shortcut: * Accept value: no * Is value required: no * Is multiple: no -* Description: Force ANSI output * Default: `false` -**no-ansi:** +#### `--no-ansi` + +Disable ANSI output -* Name: `--no-ansi` -* Shortcut: * Accept value: no * Is value required: no * Is multiple: no -* Description: Disable ANSI output * Default: `false` -**no-interaction:** +#### `--no-interaction|-n` + +Do not ask any interactive question -* Name: `--no-interaction` -* Shortcut: `-n` * Accept value: no * Is value required: no * Is multiple: no -* Description: Do not ask any interactive question * Default: `false` -list ----- +`list` +------ + +Lists commands -* Description: Lists commands -* Usage: +### Usage - * `list [--raw] [--format FORMAT] [--] []` +* `list [--raw] [--format FORMAT] [--] []` The list command lists all commands: @@ -155,222 +148,203 @@ It's also possible to get raw list of commands (useful for embedding command run php app/console list --raw -### Arguments: +### Arguments -**namespace:** +#### `namespace` + +The namespace name -* Name: namespace * Is required: no * Is array: no -* Description: The namespace name * Default: `NULL` -### Options: +### Options + +#### `--raw` -**raw:** +To output raw command list -* Name: `--raw` -* Shortcut: * Accept value: no * Is value required: no * Is multiple: no -* Description: To output raw command list * Default: `false` -**format:** +#### `--format` + +The output format (txt, xml, json, or md) -* Name: `--format` -* Shortcut: * Accept value: yes * Is value required: yes * Is multiple: no -* Description: The output format (txt, xml, json, or md) * Default: `'txt'` -descriptor:command1 -------------------- +`descriptor:command1` +--------------------- + +command 1 description -* Description: command 1 description -* Usage: +### Usage - * `descriptor:command1` - * `alias1` - * `alias2` +* `descriptor:command1` +* `alias1` +* `alias2` command 1 help -### Options: +### Options -**help:** +#### `--help|-h` + +Display this help message -* Name: `--help` -* Shortcut: `-h` * Accept value: no * Is value required: no * Is multiple: no -* Description: Display this help message * Default: `false` -**quiet:** +#### `--quiet|-q` + +Do not output any message -* Name: `--quiet` -* Shortcut: `-q` * Accept value: no * Is value required: no * Is multiple: no -* Description: Do not output any message * Default: `false` -**verbose:** +#### `--verbose|-v|-vv|-vvv` + +Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug -* Name: `--verbose` -* Shortcut: `-v|-vv|-vvv` * Accept value: no * Is value required: no * Is multiple: no -* Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug * Default: `false` -**version:** +#### `--version|-V` + +Display this application version -* Name: `--version` -* Shortcut: `-V` * Accept value: no * Is value required: no * Is multiple: no -* Description: Display this application version * Default: `false` -**ansi:** +#### `--ansi` + +Force ANSI output -* Name: `--ansi` -* Shortcut: * Accept value: no * Is value required: no * Is multiple: no -* Description: Force ANSI output * Default: `false` -**no-ansi:** +#### `--no-ansi` + +Disable ANSI output -* Name: `--no-ansi` -* Shortcut: * Accept value: no * Is value required: no * Is multiple: no -* Description: Disable ANSI output * Default: `false` -**no-interaction:** +#### `--no-interaction|-n` + +Do not ask any interactive question -* Name: `--no-interaction` -* Shortcut: `-n` * Accept value: no * Is value required: no * Is multiple: no -* Description: Do not ask any interactive question * Default: `false` -descriptor:command2 -------------------- +`descriptor:command2` +--------------------- + +command 2 description -* Description: command 2 description -* Usage: +### Usage - * `descriptor:command2 [-o|--option_name] [--] ` - * `descriptor:command2 -o|--option_name ` - * `descriptor:command2 ` +* `descriptor:command2 [-o|--option_name] [--] ` +* `descriptor:command2 -o|--option_name ` +* `descriptor:command2 ` command 2 help -### Arguments: +### Arguments -**argument_name:** +#### `argument_name` -* Name: argument_name * Is required: yes * Is array: no -* Description: * Default: `NULL` -### Options: +### Options -**option_name:** +#### `--option_name|-o` -* Name: `--option_name` -* Shortcut: `-o` * Accept value: no * Is value required: no * Is multiple: no -* Description: * Default: `false` -**help:** +#### `--help|-h` + +Display this help message -* Name: `--help` -* Shortcut: `-h` * Accept value: no * Is value required: no * Is multiple: no -* Description: Display this help message * Default: `false` -**quiet:** +#### `--quiet|-q` + +Do not output any message -* Name: `--quiet` -* Shortcut: `-q` * Accept value: no * Is value required: no * Is multiple: no -* Description: Do not output any message * Default: `false` -**verbose:** +#### `--verbose|-v|-vv|-vvv` + +Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug -* Name: `--verbose` -* Shortcut: `-v|-vv|-vvv` * Accept value: no * Is value required: no * Is multiple: no -* Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug * Default: `false` -**version:** +#### `--version|-V` + +Display this application version -* Name: `--version` -* Shortcut: `-V` * Accept value: no * Is value required: no * Is multiple: no -* Description: Display this application version * Default: `false` -**ansi:** +#### `--ansi` + +Force ANSI output -* Name: `--ansi` -* Shortcut: * Accept value: no * Is value required: no * Is multiple: no -* Description: Force ANSI output * Default: `false` -**no-ansi:** +#### `--no-ansi` + +Disable ANSI output -* Name: `--no-ansi` -* Shortcut: * Accept value: no * Is value required: no * Is multiple: no -* Description: Disable ANSI output * Default: `false` -**no-interaction:** +#### `--no-interaction|-n` + +Do not ask any interactive question -* Name: `--no-interaction` -* Shortcut: `-n` * Accept value: no * Is value required: no * Is multiple: no -* Description: Do not ask any interactive question * Default: `false` diff --git a/src/Symfony/Component/Console/Tests/Fixtures/command_1.md b/src/Symfony/Component/Console/Tests/Fixtures/command_1.md index 34ed3ea7709b3..e9a0180b02ba9 100644 --- a/src/Symfony/Component/Console/Tests/Fixtures/command_1.md +++ b/src/Symfony/Component/Console/Tests/Fixtures/command_1.md @@ -1,11 +1,12 @@ -descriptor:command1 -------------------- +`descriptor:command1` +--------------------- -* Description: command 1 description -* Usage: +command 1 description - * `descriptor:command1` - * `alias1` - * `alias2` +### Usage + +* `descriptor:command1` +* `alias1` +* `alias2` command 1 help diff --git a/src/Symfony/Component/Console/Tests/Fixtures/command_2.md b/src/Symfony/Component/Console/Tests/Fixtures/command_2.md index 6f538b6407947..41f51f0196b77 100644 --- a/src/Symfony/Component/Console/Tests/Fixtures/command_2.md +++ b/src/Symfony/Component/Console/Tests/Fixtures/command_2.md @@ -1,33 +1,29 @@ -descriptor:command2 -------------------- +`descriptor:command2` +--------------------- -* Description: command 2 description -* Usage: +command 2 description - * `descriptor:command2 [-o|--option_name] [--] ` - * `descriptor:command2 -o|--option_name ` - * `descriptor:command2 ` +### Usage + +* `descriptor:command2 [-o|--option_name] [--] ` +* `descriptor:command2 -o|--option_name ` +* `descriptor:command2 ` command 2 help -### Arguments: +### Arguments -**argument_name:** +#### `argument_name` -* Name: argument_name * Is required: yes * Is array: no -* Description: * Default: `NULL` -### Options: +### Options -**option_name:** +#### `--option_name|-o` -* Name: `--option_name` -* Shortcut: `-o` * Accept value: no * Is value required: no * Is multiple: no -* Description: * Default: `false` diff --git a/src/Symfony/Component/Console/Tests/Fixtures/input_argument_1.md b/src/Symfony/Component/Console/Tests/Fixtures/input_argument_1.md index 88f311ab534b1..7516cbd4c8cd6 100644 --- a/src/Symfony/Component/Console/Tests/Fixtures/input_argument_1.md +++ b/src/Symfony/Component/Console/Tests/Fixtures/input_argument_1.md @@ -1,7 +1,5 @@ -**argument_name:** +#### `argument_name` -* Name: argument_name * Is required: yes * Is array: no -* Description: * Default: `NULL` diff --git a/src/Symfony/Component/Console/Tests/Fixtures/input_argument_2.md b/src/Symfony/Component/Console/Tests/Fixtures/input_argument_2.md index 3cdb00cc81867..2e7e7580ce80b 100644 --- a/src/Symfony/Component/Console/Tests/Fixtures/input_argument_2.md +++ b/src/Symfony/Component/Console/Tests/Fixtures/input_argument_2.md @@ -1,7 +1,7 @@ -**argument_name:** +#### `argument_name` + +argument description -* Name: argument_name * Is required: no * Is array: yes -* Description: argument description * Default: `array ()` diff --git a/src/Symfony/Component/Console/Tests/Fixtures/input_argument_3.md b/src/Symfony/Component/Console/Tests/Fixtures/input_argument_3.md index be1c443ae0dcf..b0dd87852ac68 100644 --- a/src/Symfony/Component/Console/Tests/Fixtures/input_argument_3.md +++ b/src/Symfony/Component/Console/Tests/Fixtures/input_argument_3.md @@ -1,7 +1,7 @@ -**argument_name:** +#### `argument_name` + +argument description -* Name: argument_name * Is required: no * Is array: no -* Description: argument description * Default: `'default_value'` diff --git a/src/Symfony/Component/Console/Tests/Fixtures/input_argument_4.md b/src/Symfony/Component/Console/Tests/Fixtures/input_argument_4.md index f026ab37672bf..b9bb7edc400b1 100644 --- a/src/Symfony/Component/Console/Tests/Fixtures/input_argument_4.md +++ b/src/Symfony/Component/Console/Tests/Fixtures/input_argument_4.md @@ -1,8 +1,8 @@ -**argument_name:** +#### `argument_name` + +multiline +argument description -* Name: argument_name * Is required: yes * Is array: no -* Description: multiline - argument description * Default: `NULL` diff --git a/src/Symfony/Component/Console/Tests/Fixtures/input_definition_2.md b/src/Symfony/Component/Console/Tests/Fixtures/input_definition_2.md index 923191cdcf9f2..ffc2bbbe853a1 100644 --- a/src/Symfony/Component/Console/Tests/Fixtures/input_definition_2.md +++ b/src/Symfony/Component/Console/Tests/Fixtures/input_definition_2.md @@ -1,9 +1,7 @@ -### Arguments: +### Arguments -**argument_name:** +#### `argument_name` -* Name: argument_name * Is required: yes * Is array: no -* Description: * Default: `NULL` diff --git a/src/Symfony/Component/Console/Tests/Fixtures/input_definition_3.md b/src/Symfony/Component/Console/Tests/Fixtures/input_definition_3.md index 40fd7b0a973cb..11f7cd6b72932 100644 --- a/src/Symfony/Component/Console/Tests/Fixtures/input_definition_3.md +++ b/src/Symfony/Component/Console/Tests/Fixtures/input_definition_3.md @@ -1,11 +1,8 @@ -### Options: +### Options -**option_name:** +#### `--option_name|-o` -* Name: `--option_name` -* Shortcut: `-o` * Accept value: no * Is value required: no * Is multiple: no -* Description: * Default: `false` diff --git a/src/Symfony/Component/Console/Tests/Fixtures/input_definition_4.md b/src/Symfony/Component/Console/Tests/Fixtures/input_definition_4.md index a31feea477cd9..c4f947f5c34b7 100644 --- a/src/Symfony/Component/Console/Tests/Fixtures/input_definition_4.md +++ b/src/Symfony/Component/Console/Tests/Fixtures/input_definition_4.md @@ -1,21 +1,16 @@ -### Arguments: +### Arguments -**argument_name:** +#### `argument_name` -* Name: argument_name * Is required: yes * Is array: no -* Description: * Default: `NULL` -### Options: +### Options -**option_name:** +#### `--option_name|-o` -* Name: `--option_name` -* Shortcut: `-o` * Accept value: no * Is value required: no * Is multiple: no -* Description: * Default: `false` diff --git a/src/Symfony/Component/Console/Tests/Fixtures/input_option_1.md b/src/Symfony/Component/Console/Tests/Fixtures/input_option_1.md index 6f9e9a7e074c6..c544a4e60c37d 100644 --- a/src/Symfony/Component/Console/Tests/Fixtures/input_option_1.md +++ b/src/Symfony/Component/Console/Tests/Fixtures/input_option_1.md @@ -1,9 +1,6 @@ -**option_name:** +#### `--option_name|-o` -* Name: `--option_name` -* Shortcut: `-o` * Accept value: no * Is value required: no * Is multiple: no -* Description: * Default: `false` diff --git a/src/Symfony/Component/Console/Tests/Fixtures/input_option_2.md b/src/Symfony/Component/Console/Tests/Fixtures/input_option_2.md index 634ac0b03c02c..293e61795d8f8 100644 --- a/src/Symfony/Component/Console/Tests/Fixtures/input_option_2.md +++ b/src/Symfony/Component/Console/Tests/Fixtures/input_option_2.md @@ -1,9 +1,8 @@ -**option_name:** +#### `--option_name|-o` + +option description -* Name: `--option_name` -* Shortcut: `-o` * Accept value: yes * Is value required: no * Is multiple: no -* Description: option description * Default: `'default_value'` diff --git a/src/Symfony/Component/Console/Tests/Fixtures/input_option_3.md b/src/Symfony/Component/Console/Tests/Fixtures/input_option_3.md index 34282896ba39a..7e89d697cbcc0 100644 --- a/src/Symfony/Component/Console/Tests/Fixtures/input_option_3.md +++ b/src/Symfony/Component/Console/Tests/Fixtures/input_option_3.md @@ -1,9 +1,8 @@ -**option_name:** +#### `--option_name|-o` + +option description -* Name: `--option_name` -* Shortcut: `-o` * Accept value: yes * Is value required: yes * Is multiple: no -* Description: option description * Default: `NULL` diff --git a/src/Symfony/Component/Console/Tests/Fixtures/input_option_4.md b/src/Symfony/Component/Console/Tests/Fixtures/input_option_4.md index 8ffba56e73265..7eb2d2ae3ea32 100644 --- a/src/Symfony/Component/Console/Tests/Fixtures/input_option_4.md +++ b/src/Symfony/Component/Console/Tests/Fixtures/input_option_4.md @@ -1,9 +1,8 @@ -**option_name:** +#### `--option_name|-o` + +option description -* Name: `--option_name` -* Shortcut: `-o` * Accept value: yes * Is value required: no * Is multiple: yes -* Description: option description * Default: `array ()` diff --git a/src/Symfony/Component/Console/Tests/Fixtures/input_option_5.md b/src/Symfony/Component/Console/Tests/Fixtures/input_option_5.md index 82f51cad30ddf..72ca43914e1f9 100644 --- a/src/Symfony/Component/Console/Tests/Fixtures/input_option_5.md +++ b/src/Symfony/Component/Console/Tests/Fixtures/input_option_5.md @@ -1,10 +1,9 @@ -**option_name:** +#### `--option_name|-o` + +multiline +option description -* Name: `--option_name` -* Shortcut: `-o` * Accept value: yes * Is value required: yes * Is multiple: no -* Description: multiline - option description * Default: `NULL` diff --git a/src/Symfony/Component/Console/Tests/Fixtures/input_option_6.md b/src/Symfony/Component/Console/Tests/Fixtures/input_option_6.md index ed1ea1c84bd53..87acd8b990828 100644 --- a/src/Symfony/Component/Console/Tests/Fixtures/input_option_6.md +++ b/src/Symfony/Component/Console/Tests/Fixtures/input_option_6.md @@ -1,9 +1,8 @@ -**option_name:** +#### `--option_name|-o|-O` + +option with multiple shortcuts -* Name: `--option_name` -* Shortcut: `-o|-O` * Accept value: yes * Is value required: yes * Is multiple: no -* Description: option with multiple shortcuts * Default: `NULL`