Skip to content

Commit 6012354

Browse files
committed
Help texts: updates based on reviews
1 parent e285aaa commit 6012354

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

src/Util/Help.php

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -409,11 +409,11 @@ private function getAllOptions()
409409
],
410410
'ignore' => [
411411
'argument' => '--ignore=<patterns>',
412-
'description' => 'Ignore files based on a comma separated list of patterns matching files and/or directories.',
412+
'description' => 'Ignore files based on a comma-separated list of patterns matching files and/or directories.',
413413
],
414414
'extensions' => [
415415
'argument' => '--extensions=<extensions>',
416-
'description' => 'Check files with the specified file extensions (comma separated list). Defaults to php,inc/php,js,css.'."\n"
416+
'description' => 'Check files with the specified file extensions (comma-separated list). Defaults to php,inc/php,js,css.'."\n"
417417
.'The type of the file can be specified using: ext/type; e.g. module/php,es/js.',
418418
],
419419
'l' => [
@@ -429,11 +429,11 @@ private function getAllOptions()
429429
],
430430
'sniffs' => [
431431
'argument' => '--sniffs=<sniffs>',
432-
'description' => 'A comma separated list of sniff codes to limit the scan to. All sniffs must be part of the standard in use.',
432+
'description' => 'A comma-separated list of sniff codes to limit the scan to. All sniffs must be part of the standard in use.',
433433
],
434434
'exclude' => [
435435
'argument' => '--exclude=<sniffs>',
436-
'description' => 'A comma separated list of sniff codes to exclude from the scan. All sniffs must be part of the standard in use.',
436+
'description' => 'A comma-separated list of sniff codes to exclude from the scan. All sniffs must be part of the standard in use.',
437437
],
438438
'blank-line' => ['spacer' => ''],
439439

@@ -458,19 +458,19 @@ private function getAllOptions()
458458
],
459459
'bootstrap' => [
460460
'argument' => '--bootstrap=<bootstrap>',
461-
'description' => 'Run the specified, comma separated, file(s) before processing begins.',
461+
'description' => 'Run the specified comma-separated file(s) before processing begins.',
462462
],
463463
'cache' => [
464464
'argument' => '--cache[=<cacheFile>]',
465-
'description' => 'Cache results between runs. Optionally, <cacheFile> can be provided to use a specific file for caching. Otherwise a temporary file is used.',
465+
'description' => 'Cache results between runs. Optionally, <cacheFile> can be provided to use a specific file for caching. Otherwise, a temporary file is used.',
466466
],
467467
'no-cache' => [
468468
'argument' => '--no-cache',
469-
'description' => 'Do not cache results between runs (this is the default).',
469+
'description' => 'Do not cache results between runs (default).',
470470
],
471471
'parallel' => [
472472
'argument' => '--parallel=<processes>',
473-
'description' => 'How many files should be checked simultaneously. Defaults to 1 (no parallel processing).'."\n"
473+
'description' => 'The number of files to be checked simultaneously. Defaults to 1 (no parallel processing).'."\n"
474474
.'If enabled, this option only takes effect if the PHP PCNTL (Process Control) extension is available.',
475475
],
476476
'suffix' => [
@@ -511,7 +511,7 @@ private function getAllOptions()
511511

512512
'w' => [
513513
'argument' => '-w',
514-
'description' => 'Include both warnings and errors (this is the default).',
514+
'description' => 'Include both warnings and errors (default).',
515515
],
516516
'n' => [
517517
'argument' => '-n',
@@ -545,7 +545,7 @@ private function getAllOptions()
545545
],
546546
'no-colors' => [
547547
'argument' => '--no-colors',
548-
'description' => 'Do not use colors in screen output (this is the default).',
548+
'description' => 'Do not use colors in screen output (default).',
549549
],
550550
'p' => [
551551
'argument' => '-p',
@@ -557,14 +557,14 @@ private function getAllOptions()
557557
],
558558
'm' => [
559559
'argument' => '-m',
560-
'description' => 'Stop error messages from being recorded . This saves a lot of memory, but stops many reports from being used.',
560+
'description' => 'Stop error messages from being recorded. This saves a lot of memory but stops many reports from being used.',
561561
],
562562
];
563563

564564
$options['Configuration Options'] = [
565565
'encoding' => [
566566
'argument' => '--encoding=<encoding>',
567-
'description' => 'The encoding of the files being checked. Defaults to utf-8.',
567+
'description' => 'The encoding of the files being checked. Defaults to "utf-8".',
568568
],
569569
'tab-width' => [
570570
'argument' => '--tab-width=<tabWidth>',

0 commit comments

Comments
 (0)