8000 minor #40387 Fix #36973: Command description consistency (danepowell) · symfony/symfony@57fb475 · GitHub
[go: up one dir, main page]
Skip to content

Commit 57fb475

Browse files
fabpotfabpot
committed
minor #40387 Fix #36973: Command description consistency (danepowell)
This PR was merged into the 4.4 branch. Discussion ---------- Fix #36973: Command description consistency | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | Fix #36973 | License | MIT | Doc PR | symfony/symfony-docs#15062 This rewords command descriptions and options to use consistent verb mood. Commits ------- 01e18b0 Fix #36973: Command description consistency
2 parents 13055b6 + 01e18b0 commit 57fb475

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+67
-67
lines changed

‎src/Symfony/Bridge/Monolog/Command/ServerLogCommand.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ protected function configure()
6060
->addOption('format', null, InputOption::VALUE_REQUIRED, 'The line format', ConsoleFormatter::SIMPLE_FORMAT)
6161
->addOption('date-format', null, InputOption::VALUE_REQUIRED, 'The date format', ConsoleFormatter::SIMPLE_DATE)
6262
->addOption('filter', null, InputOption::VALUE_REQUIRED, 'An expression to filter log. Example: "level > 200 or channel in [\'app\', \'doctrine\']"')
63-
->setDescription('Starts a log server that displays logs in real time')
63+
->setDescription('Start a log server that displays logs in real time')
6464
->setHelp(<<<'EOF'
6565
<info>%command.name%</info> starts a log server to display in real time the log
6666
messages generated by your application:

‎src/Symfony/Bridge/Twig/Command/DebugCommand.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ protected function configure()
7474
new InputOption('filter', null, InputOption::VALUE_REQUIRED, 'Show details for all entries matching this filter'),
7575
new InputOption('format', null, InputOption::VALUE_REQUIRED, 'The output format (text or json)', 'text'),
7676
])
77-
->setDescription('Shows a list of twig functions, filters, globals and tests')
77+
->setDescription('Show a list of twig functions, filters, globals and tests')
7878
->setHelp(<<<'EOF'
7979
The <info>%command.name%</info> command outputs a list of twig functions,
8080
filters, globals and tests.

‎src/Symfony/Bridge/Twig/Command/LintCommand.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ public function __construct(Environment $twig)
4848
protected function configure()
4949
{
5050
$this
51-
->setDescription('Lints a template and outputs encountered errors')
51+
->setDescription('Lint a template and outputs encountered errors')
5252
->addOption('format', null, InputOption::VALUE_REQUIRED, 'The output format', 'txt')
5353
->addOption('show-deprecations', null, InputOption::VALUE_NONE, 'Show deprecations as errors')
5454
->addArgument('filename', InputArgument::IS_ARRAY, 'A file, a directory or "-" for reading from STDIN')

‎src/Symfony/Bundle/FrameworkBundle/Command/AboutCommand.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ class AboutCommand extends Command
3737
protected function configure()
3838
{
3939
$this
40-
->setDescription('Displays information about the current project')
40+
->setDescription('Display information about the current project')
4141
->setHelp(<<<'EOT'
4242
The <info>%command.name%</info> command displays information about the current Symfony project.
4343

‎src/Symfony/Bundle/FrameworkBundle/Command/AssetsInstallCommand.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,10 +65,10 @@ protected function configure()
6565
->setDefinition([
6666
new InputArgument('target', InputArgument::OPTIONAL, 'The target directory', null),
6767
])
68-
->addOption('symlink', null, InputOption::VALUE_NONE, 'Symlinks the assets instead of copying it')
68+
->addOption('symlink', null, InputOption::VALUE_NONE, 'Symlink the assets instead of copying them')
6969
->addOption('relative', null, InputOption::VALUE_NONE, 'Make relative symlinks')
7070
->addOption('no-cleanup', null, InputOption::VALUE_NONE, 'Do not remove the assets of the bundles that no longer exist')
71-
->setDescription('Installs bundles web assets under a public directory')
71+
->setDescription('Install bundle\'s web assets under a public directory')
7272
->setHelp(<<<'EOT'
7373
The <info>%command.name%</info> command installs bundle assets into a given
7474
directory (e.g. the <comment>public</comment> directory).

‎src/Symfony/Bundle/FrameworkBundle/Command/CacheClearCommand.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ protected function configure()
5757
new InputOption('no-warmup', '', InputOption::VALUE_NONE, 'Do not warm up the cache'),
5858
new InputOption('no-optional-warmers', '', InputOption::VALUE_NONE, 'Skip optional cache warmers (faster)'),
5959
])
60-
->setDescription('Clears the cache')
60+
->setDescription('Clear the cache')
6161
->setHelp(<<<'EOF'
6262
The <info>%command.name%</info> command clears the application cache for a given environment
6363
and debug mode:

‎src/Symfony/Bundle/FrameworkBundle/Command/CachePoolClearCommand.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ protected function configure()
4747
->setDefinition([
4848
new InputArgument('pools', InputArgument::IS_ARRAY | InputArgument::REQUIRED, 'A list of cache pools or cache pool clearers'),
4949
])
50-
->setDescription('Clears cache pools')
50+
->setDescription('Clear cache pools')
5151
->setHelp(<<<'EOF'
5252
The <info>%command.name%</info> command clears the given cache pools or cache pool clearers.
5353

‎src/Symfony/Bundle/FrameworkBundle/Command/CachePoolDeleteCommand.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ protected function configure()
4646
new InputArgument('pool', InputArgument::REQUIRED, 'The cache pool from which to delete an item'),
4747
new InputArgument('key', InputArgument::REQUIRED, 'The cache key to delete from the pool'),
4848
])
49-
->setDescription('Deletes an item from a cache pool')
49+
->setDescription('Delete an item from a cache pool')
5050
->setHelp(<<<'EOF'
5151
The <info>%command.name%</info> deletes an item from a given cache pool.
5252

‎src/Symfony/Bundle/FrameworkBundle/Command/CachePoolPruneCommand.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ public function __construct(iterable $pools)
4444
protected function configure()
4545
{
4646
$this
47-
->setDescription('Prunes cache pools')
47+
->setDescription('Prune cache pools')
4848
->setHelp(<<<'EOF'
4949
The <info>%command.name%</info> command deletes all expired items from all pruneable pools.
5050

‎src/Symfony/Bundle/FrameworkBundle/Command/CacheWarmupCommand.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ protected function configure()
4747
->setDefinition([
4848
new InputOption('no-optional-warmers', '', InputOption::VALUE_NONE, 'Skip optional cache warmers (faster)'),
4949
])
50-
->setDescription('Warms up an empty cache')
50+
->setDescription('Warm up an empty cache')
5151
->setHelp(<<<'EOF'
5252
The <info>%command.name%</info> command warms up the cache.
5353

‎src/Symfony/Bundle/FrameworkBundle/Command/ConfigDebugCommand.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ protected function configure()
4141
new InputArgument('name', InputArgument::OPTIONAL, 'The bundle name or the extension alias'),
4242
new InputArgument('path', InputArgument::OPTIONAL, 'The configuration option path'),
4343
])
44-
->setDescription('Dumps the current configuration for an extension')
44+
->setDescription('Dump the current configuration for an extension')
4545
->setHelp(<<<'EOF'
4646
The <info>%command.name%</info> command dumps the current configuration for an
4747
extension/bundle.

‎src/Symfony/Bundle/FrameworkBundle/Command/ConfigDumpReferenceCommand.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ protected function configure()
4444
new InputArgument('path', InputArgument::OPTIONAL, 'The configuration option path'),
4545
new InputOption('format', null, InputOption::VALUE_REQUIRED, 'The output format (yaml or xml)', 'yaml'),
4646
])
47-
->setDescription('Dumps the default configuration for an extension')
47+
->setDescription('Dump the default configuration for an extension')
4848
->setHelp(<<<'EOF'
4949
The <info>%command.name%</info> command dumps the default configuration for an
5050
extension/bundle.

‎src/Symfony/Bundle/FrameworkBundle/Command/ContainerDebugCommand.php

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -51,20 +51,20 @@ protected function configure()
5151
$this
5252
->setDefinition([
5353
new InputArgument('name', InputArgument::OPTIONAL, 'A service name (foo)'),
54-
new InputOption('show-private', null, InputOption::VALUE_NONE, 'Used to show public *and* private services (deprecated)'),
55-
new InputOption('show-arguments', null, InputOption::VALUE_NONE, 'Used to show arguments in services'),
56-
new InputOption('show-hidden', null, InputOption::VALUE_NONE, 'Used to show hidden (internal) services'),
57-
new InputOption('tag', null, InputOption::VALUE_REQUIRED, 'Shows all services with a specific tag'),
58-
new InputOption('tags', null, InputOption::VALUE_NONE, 'Displays tagged services for an application'),
59-
new InputOption('parameter', null, InputOption::VALUE_REQUIRED, 'Displays a specific parameter for an application'),
60-
new InputOption('parameters', null, InputOption::VALUE_NONE, 'Displays parameters for an application'),
61-
new InputOption('types', null, InputOption::VALUE_NONE, 'Displays types (classes/interfaces) available in the container'),
62-
new InputOption('env-var', null, InputOption::VALUE_REQUIRED, 'Displays a specific environment variable used in the container'),
63-
new InputOption('env-vars', null, InputOption::VALUE_NONE, 'Displays environment variables used in the container'),
54+
new InputOption('show-private', null, InputOption::VALUE_NONE, 'Show public *and* private services (deprecated)'),
55+
new InputOption('show-arguments', null, InputOption::VALUE_NONE, 'Show arguments in services'),
56+
new InputOption('show-hidden', null, InputOption::VALUE_NONE, 'Show hidden (internal) services'),
57+
new InputOption('tag', null, InputOption::VALUE_REQUIRED, 'Show all services with a specific tag'),
58+
new InputOption('tags', null, InputOption::VALUE_NONE, 'Display tagged services for an application'),
59+
new InputOption('parameter', null, InputOption::VALUE_REQUIRED, 'Display a specific parameter for an application'),
60+
new InputOption('parameters', null, InputOption::VALUE_NONE, 'Display parameters for an application'),
61+
new InputOption('types', null, InputOption::VALUE_NONE, 'Display types (classes/interfaces) available in the container'),
62+
new InputOption('env-var', null, InputOption::VALUE_REQUIRED, 'Display a specific environment variable used in the container'),
63+
new InputOption('env-vars', null, InputOption::VALUE_NONE, 'Display environment variables used in the container'),
6464
new InputOption('format', null, InputOption::VALUE_REQUIRED, 'The output format (txt, xml, json, or md)', 'txt'),
6565
new InputOption('raw', null, InputOption::VALUE_NONE, 'To output raw description'),
6666
])
67-
->setDescription('Displays current services for an application')
67+
->setDescription('Display current services for an application')
6868
->setHelp(<<<'EOF'
6969
The <info>%command.name%</info> command displays all configured <comment>public</comment> services:
7070

‎src/Symfony/Bundle/FrameworkBundle/Command/ContainerLintCommand.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ final class ContainerLintCommand extends Command
4141
protected function configure()
4242
{
4343
$this
44-
->setDescription('Ensures that arguments injected into services match type declarations')
44+
->setDescription('Ensure that arguments injected into services match type declarations')
4545
->setHelp('This command parses service definitions and ensures that injected values match the type declarations of each services\' class.')
4646
;
4747
}

‎src/Symfony/Bundle/FrameworkBundle/Command/DebugAutowiringCommand.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ protected function configure()
5050
new InputArgument('search', InputArgument::OPTIONAL, 'A search filter'),
5151
new InputOption('all', null, InputOption::VALUE_NONE, 'Show also services that are not aliased'),
5252
])
53-
->setDescription('Lists classes/interfaces you can use for autowiring')
53+
->setDescription('List classes/interfaces you can use for autowiring')
5454
->setHelp(<<<'EOF'
5555
The <info>%command.name%</info> command displays the classes and interfaces that
5656
you can use as type-hints for autowiring:

‎src/Symfony/Bundle/FrameworkBundle/Command/EventDispatcherDebugCommand.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ protected function configure()
5050
new InputOption('format', null, InputOption::VALUE_REQUIRED, 'The output format (txt, xml, json, or md)', 'txt'),
5151
new InputOption('raw', null, InputOption::VALUE_NONE, 'To output raw description'),
5252
])
53-
->setDescription('Displays configured listeners for an application')
53+
->setDescription('Display configured listeners for an application')
5454
->setHelp(<<<'EOF'
5555
The <info>%command.name%</info> command displays all configured listeners:
5656

‎src/Symfony/Bundle/FrameworkBundle/Command/RouterDebugCommand.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ protected function configure()
5757
new InputOption('format', null, InputOption::VALUE_REQUIRED, 'The output format (txt, xml, json, or md)', 'txt'),
5858
new InputOption('raw', null, InputOption::VALUE_NONE, 'To output raw route(s)'),
5959
])
60-
->setDescription('Displays current routes for an application')
60+
->setDescription('Display current routes for an application')
6161
->setHelp(<<<'EOF'
6262
The <info>%command.name%</info> displays the configured routes:
6363

‎src/Symfony/Bundle/FrameworkBundle/Command/RouterMatchCommand.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,11 @@ protected function configure()
4949
$this
5050
->setDefinition([
5151
new InputArgument('path_info', InputArgument::REQUIRED, 'A path info'),
52-
new InputOption('method', null, InputOption::VALUE_REQUIRED, 'Sets the HTTP method'),
53-
new InputOption('scheme', null, InputOption::VALUE_REQUIRED, 'Sets the URI scheme (usually http or https)'),
54-
new InputOption('host', null, InputOption::VALUE_REQUIRED, 'Sets the URI host'),
52+
new InputOption('method', null, InputOption::VALUE_REQUIRED, 'Set the HTTP method'),
53+
new InputOption('scheme', null, InputOption::VALUE_REQUIRED, 'Set the URI scheme (usually http or https)'),
54+
new InputOption('host', null, InputOption::VALUE_REQUIRED, 'Set the URI host'),
5555
])
56-
->setDescription('Helps debug routes by simulating a path info match')
56+
->setDescription('Help debug routes by simulating a path info match')
5757
->setHelp(<<<'EOF'
5858
The <info>%command.name%</info> shows which routes match a given request and which don't and for what reason:
5959

‎src/Symfony/Bundle/FrameworkBundle/Command/SecretsDecryptToLocalCommand.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ public function __construct(AbstractVault $vault, AbstractVault $localVault = nu
4242
protected function configure()
4343
{
4444
$this
45-
->setDescription('Decrypts all secrets and stores them in the local vault.')
46-
->addOption('force', 'f', InputOption::VALUE_NONE, 'Forces overriding of secrets that already exist in the local vault')
45+
->setDescription('Decrypt all secrets and stores them in the local vault.')
46+
->addOption('force', 'f', InputOption::VALUE_NONE, 'Force overriding of secrets that already exist in the local vault')
4747
->setHelp(<<<'EOF'
4848
The <info>%command.name%</info> command decrypts all secrets and copies them in the local vault.
4949

‎src/Symfony/Bundle/FrameworkBundle/Command/SecretsEncryptFromLocalCommand.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public function __construct(AbstractVault $vault, AbstractVault $localVault = nu
4141
protected function configure()
4242
{
4343
$this
44-
->setDescription('Encrypts all local secrets to the vault.')
44+
->setDescription('Encrypt all local secrets to the vault.')
4545
->setHelp(<<<'EOF'
4646
The <info>%command.name%</info> command encrypts all locally overridden secrets to the vault.
4747

‎src/Symfony/Bundle/FrameworkBundle/Command/SecretsGenerateKeysCommand.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ public function __construct(AbstractVault $vault, AbstractVault $localVault = nu
4444
protected function configure()
4545
{
4646
$this
47-
->setDescription('Generates new encryption keys.')
48-
->addOption('local', 'l', InputOption::VALUE_NONE, 'Updates the local vault.')
49-
->addOption('rotate', 'r', InputOption::VALUE_NONE, 'Re-encrypts existing secrets with the newly generated keys.')
47+
->setDescription('Generate new encryption keys.')
48+
->addOption('local', 'l', InputOption::VALUE_NONE, 'Update the local vault.')
49+
->addOption('rotate', 'r', InputOption::VALUE_NONE, 'Re-encrypt existing secrets with the newly generated keys.')
5050
->setHelp(<<<'EOF'
5151
The <info>%command.name%</info> command generates a new encryption key.
5252

‎src/Symfony/Bundle/FrameworkBundle/Command/SecretsListCommand.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ public function __construct(AbstractVault $vault, AbstractVault $localVault = nu
4545
protected function configure()
4646
{
4747
$this
48-
->setDescription('Lists all secrets.')
48+
->setDescription('List all secrets.')
4949
->addOption('reveal', 'r', InputOption::VALUE_NONE, 'Display decrypted values alongside names')
5050
->setHelp(<<<'EOF'
5151
The <info>%command.name%</info> command list all stored secrets.

‎src/Symfony/Bundle/FrameworkBundle/Command/SecretsRemoveCommand.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ public function __construct(AbstractVault $vault, AbstractVault $localVault = nu
4444
protected function configure()
4545
{
4646
$this
47-
->setDescription('Removes a secret from the vault.')
47+
->setDescription('Remove a secret from the vault.')
4848
->addArgument('name', InputArgument::REQUIRED, 'The name of the secret')
49-
->addOption('local', 'l', InputOption::VALUE_NONE, 'Updates the local vault.')
49+
->addOption('local', 'l', InputOption::VALUE_NONE, 'Update the local vault.')
5050
->setHelp(<<<'EOF'
5151
The <info>%command.name%</info> command removes a secret from the vault.
5252

‎src/Symfony/Bundle/FrameworkBundle/Command/SecretsSetCommand.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,11 @@ public function __construct(AbstractVault $vault, AbstractVault $localVault = nu
4545
protected function configure()
4646
{
4747
$this
48-
->setDescription('Sets a secret in the vault.')
48+
->setDescription('Set a secret in the vault.')
4949
->addArgument('name', InputArgument::REQUIRED, 'The name of the secret')
5050
->addArgument('file', InputArgument::OPTIONAL, 'A file where to read the secret from or "-" for reading from STDIN')
51-
->addOption('local', 'l', InputOption::VALUE_NONE, 'Updates the local vault.')
52-
->addOption('random', 'r', InputOption::VALUE_OPTIONAL, 'Generates a random value.', false)
51+
->addOption('local', 'l', InputOption::VALUE_NONE, 'Update the local vault.')
52+
->addOption('random', 'r', InputOption::VALUE_OPTIONAL, 'Generate a random value.', false)
5353
->setHelp(<<<'EOF'
5454
The <info>%command.name%</info> command stores a secret in the vault.
5555

‎src/Symfony/Bundle/FrameworkBundle/Command/TranslationDebugCommand.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,11 +82,11 @@ protected function configure()
8282
new InputArgument('locale', InputArgument::REQUIRED, 'The locale'),
8383
new InputArgument('bundle', InputArgument::OPTIONAL, 'The bundle name or directory where to load the messages'),
8484
new InputOption('domain', null, InputOption::VALUE_OPTIONAL, 'The messages domain'),
85-
new InputOption('only-missing', null, InputOption::VALUE_NONE, 'Displays only missing messages'),
86-
new InputOption('only-unused', null, InputOption::VALUE_NONE, 'Displays only unused messages'),
85+
new InputOption('only-missing', null, InputOption::VALUE_NONE, 'Display only missing messages'),
86+
new InputOption('only-unused', null, InputOption::VALUE_NONE, 'Display only unused messages'),
8787
new InputOption('all', null, InputOption::VALUE_NONE, 'Load messages from all registered bundles'),
8888
])
89-
->setDescription('Displays translation messages information')
89+
->setDescription('Display translation messages information')
9090
->setHelp(<<<'EOF'
9191
The <info>%command.name%</info> command helps finding unused or missing translation
9292
messages and comparing them with the fallback ones by inspecting the

‎src/Symfony/Bundle/FrameworkBundle/Command/TranslationUpdateCommand.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ protected function configure()
8585
new InputOption('xliff-version', null, InputOption::VALUE_OPTIONAL, 'Override the default xliff version', '1.2'),
8686
new InputOption('sort', null, InputOption::VALUE_OPTIONAL, 'Return list of messages sorted alphabetically', 'asc'),
8787
])
88-
->setDescription('Updates the translation file')
88+
->setDescription('Update the translation file')
8989
->setHelp(<<<'EOF'
9090
The <info>%command.name%</info> command extracts translation strings from templates
9191
of a given bundle or the default translations directory. It can display them or merge

‎src/Symfony/Bundle/FrameworkBundle/Command/WorkflowDumpCommand.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ protected function configure()
4040
->setDefinition([
4141
new InputArgument('name', InputArgument::REQUIRED, 'A workflow name'),
4242
new InputArgument('marking', InputArgument::IS_ARRAY, 'A marking (a list of places)'),
43-
new InputOption('label', 'l', InputOption::VALUE_REQUIRED, 'Labels a graph'),
43+
new InputOption('label', 'l', InputOption::VALUE_REQUIRED, 'Label a graph'),
4444
new InputOption('dump-format', null, InputOption::VALUE_REQUIRED, 'The dump format [dot|puml]', 'dot'),
4545
])
4646
->setDescription('Dump a workflow')

0 commit comments

Comments
 (0)
0