Skip to content

Commit

Permalink
minor #5392 PhpdocScalarFixer - Fix description (localheinz)
Browse files Browse the repository at this point in the history
This PR was merged into the 2.17 branch.

Discussion
----------

PhpdocScalarFixer - Fix description

This PR

* [x] fixes the description of the `types` option of the `PhpdocScalarFixer`

Commits
-------

a0da444 Fix: Description
  • Loading branch information
SpacePossum committed Dec 31, 2020
2 parents f6c598f + a0da444 commit b4c9884
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion doc/rules/phpdoc/phpdoc_scalar.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Configuration
``types``
~~~~~~~~~

A map of types to fix.
A list of types to fix.

Allowed values: a subset of ``['boolean', 'callback', 'double', 'integer', 'real', 'str']``

Expand Down
2 changes: 1 addition & 1 deletion src/Fixer/Phpdoc/PhpdocScalarFixer.php
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ public function getPriority()
protected function createConfigurationDefinition()
{
return new FixerConfigurationResolver([
(new FixerOptionBuilder('types', 'A map of types to fix.'))
(new FixerOptionBuilder('types', 'A list of types to fix.'))
->setAllowedValues([new AllowedValueSubset(array_keys(self::$types))])
->setDefault(['boolean', 'double', 'integer', 'real', 'str']) // TODO 3.0 add "callback"
->getOption(),
Expand Down

0 comments on commit b4c9884

Please sign in to comment.