Skip to content

Commit 9dca1e2

Browse files
committed
minor #13231 [WIP] Made help information of commands more consistent (WouterJ)
This PR was squashed before being merged into the 2.3 branch (closes #13231). Discussion ---------- [WIP] Made help information of commands more consistent | Q | A | --- | --- | Test pass | Not yet | License | MIT | Fixed tickets | - Commits ------- 602d687 [WIP] Made help information of commands more consistent
2 parents 32d3038 + f831ab5 commit 9dca1e2

File tree

5 files changed

+19
-34
lines changed

5 files changed

+19
-34
lines changed

Command/AssetsInstallCommand.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,21 +39,21 @@ protected function configure()
3939
->setDescription('Installs bundles web assets under a public web directory')
4040
->setHelp(<<<EOT
4141
The <info>%command.name%</info> command installs bundle assets into a given
42-
directory (e.g. the web directory).
42+
directory (e.g. the <comment>web</comment> directory).
4343
44-
<info>php %command.full_name% web</info>
44+
<info>php %command.full_name% web</info>
4545
46-
A "bundles" directory will be created inside the target directory, and the
46+
A "bundles" directory will be created inside the target directory and the
4747
"Resources/public" directory of each bundle will be copied into it.
4848
4949
To create a symlink to each bundle instead of copying its assets, use the
5050
<info>--symlink</info> option:
5151
52-
<info>php %command.full_name% web --symlink</info>
52+
<info>php %command.full_name% web --symlink</info>
5353
5454
To make symlink relative, add the <info>--relative</info> option:
5555
56-
<info>php %command.full_name% web --symlink --relative</info>
56+
<info>php %command.full_name% web --symlink --relative</info>
5757
5858
EOT
5959
)

Command/CacheClearCommand.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ protected function configure()
4141
The <info>%command.name%</info> command clears the application cache for a given environment
4242
and debug mode:
4343
44-
<info>php %command.full_name% --env=dev</info>
45-
<info>php %command.full_name% --env=prod --no-debug</info>
44+
<info>php %command.full_name% --env=dev</info>
45+
<info>php %command.full_name% --env=prod --no-debug</info>
4646
EOF
4747
)
4848
;

Command/ContainerDebugCommand.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,23 +59,23 @@ protected function configure()
5959
<info>php %command.full_name% validator</info>
6060
6161
By default, private services are hidden. You can display all services by
62-
using the --show-private flag:
62+
using the <info>--show-private</info> flag:
6363
6464
<info>php %command.full_name% --show-private</info>
6565
6666
Use the --tags option to display tagged <comment>public</comment> services grouped by tag:
6767
6868
<info>php %command.full_name% --tags</info>
6969
70-
Find all services with a specific tag by specifying the tag name with the --tag option:
70+
Find all services with a specific tag by specifying the tag name with the <info>--tag</info> option:
7171
7272
<info>php %command.full_name% --tag=form.type</info>
7373
74-
Use the --parameters option to display all parameters:
74+
Use the <info>--parameters</info> option to display all parameters:
7575
7676
<info>php %command.full_name% --parameters</info>
7777
78-
Display a specific parameter by specifying his name with the --parameter option:
78+
Display a specific parameter by specifying his name with the <info>--parameter</info> option:
7979
8080
<info>php %command.full_name% --parameter=kernel.debug</info>
8181
EOF

Command/RouterApacheDumperCommand.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ protected function configure()
4949
$this
5050
->setName('router:dump-apache')
5151
->setDefinition(array(
52-
new InputArgument('script_name', InputArgument::OPTIONAL, 'The script name of the application\'s front controller.'),
52+
new InputArgument('script_name', InputArgument::OPTIONAL, 'The script name of the application\'s front controller'),
5353
new InputOption('base-uri', null, InputOption::VALUE_REQUIRED, 'The base URI'),
5454
))
5555
->setDescription('Dumps all routes as Apache rewrite rules')

Command/TranslationUpdateCommand.php

Lines changed: 7 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -36,26 +36,11 @@ protected function configure()
3636
->setDefinition(array(
3737
new InputArgument('locale', InputArgument::REQUIRED, 'The locale'),
3838
new InputArgument('bundle', InputArgument::REQUIRED, 'The bundle where to load the messages'),
39-
new InputOption(
40-
'prefix', null, InputOption::VALUE_OPTIONAL,
41-
'Override the default prefix', '__'
42-
),
43-
new InputOption(
44-
'output-format', null, InputOption::VALUE_OPTIONAL,
45-
'Override the default output format', 'yml'
46-
),
47-
new InputOption(
48-
'dump-messages', null, InputOption::VALUE_NONE,
49-
'Should the messages be dumped in the console'
50-
),
51-
new InputOption(
52-
'force', null, InputOption::VALUE_NONE,
53-
'Should the update be done'
54-
),
55-
new InputOption(
56-
'clean', null, InputOption::VALUE_NONE,
57-
'Should clean not found messages'
58-
),
39+
new InputOption('prefix', null, InputOption::VALUE_OPTIONAL, 'Override the default prefix', '__'),
40+
new InputOption('output-format', null, InputOption::VALUE_OPTIONAL, 'Override the default output format', 'yml'),
41+
new InputOption('dump-messages', null, InputOption::VALUE_NONE, 'Should the messages be dumped in the console'),
42+
new InputOption('force', null, InputOption::VALUE_NONE, 'Should the update be done'),
43+
new InputOption('clean', null, InputOption::VALUE_NONE, 'Should clean not found messages'),
5944
))
6045
->setDescription('Updates the translation file')
6146
->setHelp(<<<EOF
@@ -64,8 +49,8 @@ protected function configure()
6449
When new translation strings are found it can automatically add a prefix to the translation
6550
message.
6651
67-
<info>php %command.full_name% --dump-messages en AcmeBundle</info>
68-
<info>php %command.full_name% --force --prefix="new_" fr AcmeBundle</info>
52+
<info>php %command.full_name% --dump-messages en AcmeBundle</info>
53+
<info>php %command.full_name% --force --prefix="new_" fr AcmeBundle</info>
6954
EOF
7055
)
7156
;

0 commit comments

Comments
 (0)