Skip to content

Commit

Permalink
sort docs
Browse files Browse the repository at this point in the history
  • Loading branch information
keradus committed Oct 31, 2023
1 parent 0fc5468 commit a83d808
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion doc/list.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2394,7 +2394,7 @@ List of Available Rules
- | ``groups``
| Sets of annotation types to be grouped together. Use ``*`` to match any tag character.
| Allowed types: ``string[][]``
| Default value: ``[['deprecated', 'link', 'see', 'since'], ['author', 'copyright', 'license'], ['category', 'package', 'subpackage'], ['property', 'property-read', 'property-write']]``
| Default value: ``[['author', 'copyright', 'license'], ['category', 'package', 'subpackage'], ['property', 'property-read', 'property-write'], ['deprecated', 'link', 'see', 'since']]``
- | ``skip_unlisted_annotations``
| Whether to skip annotations that are not listed in any group.
| Allowed types: ``bool``
Expand Down
2 changes: 1 addition & 1 deletion doc/ruleSets/Symfony.rst
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ Rules
- `phpdoc_scalar <./../rules/phpdoc/phpdoc_scalar.rst>`_
- `phpdoc_separation <./../rules/phpdoc/phpdoc_separation.rst>`_ with config:

``['groups' => [['deprecated', 'link', 'see', 'since'], ['author', 'copyright', 'license'], ['category', 'package', 'subpackage'], ['property', 'property-read', 'property-write'], ['Annotation', 'NamedArgumentConstructor', 'Target']]]``
``['groups' => [['Annotation', 'NamedArgumentConstructor', 'Target'], ['author', 'copyright', 'license'], ['category', 'package', 'subpackage'], ['property', 'property-read', 'property-write'], ['deprecated', 'link', 'see', 'since']]]``

- `phpdoc_single_line_var_spacing <./../rules/phpdoc/phpdoc_single_line_var_spacing.rst>`_
- `phpdoc_summary <./../rules/phpdoc/phpdoc_summary.rst>`_
Expand Down
6 changes: 3 additions & 3 deletions doc/rules/phpdoc/phpdoc_separation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ character.

Allowed types: ``string[][]``

Default value: ``[['deprecated', 'link', 'see', 'since'], ['author', 'copyright', 'license'], ['category', 'package', 'subpackage'], ['property', 'property-read', 'property-write']]``
Default value: ``[['author', 'copyright', 'license'], ['category', 'package', 'subpackage'], ['property', 'property-read', 'property-write'], ['deprecated', 'link', 'see', 'since']]``

``skip_unlisted_annotations``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -157,10 +157,10 @@ The rule is part of the following rule sets:

- `@PhpCsFixer <./../../ruleSets/PhpCsFixer.rst>`_ with config:

``['groups' => [['deprecated', 'link', 'see', 'since'], ['author', 'copyright', 'license'], ['category', 'package', 'subpackage'], ['property', 'property-read', 'property-write'], ['Annotation', 'NamedArgumentConstructor', 'Target']]]``
``['groups' => [['Annotation', 'NamedArgumentConstructor', 'Target'], ['author', 'copyright', 'license'], ['category', 'package', 'subpackage'], ['property', 'property-read', 'property-write'], ['deprecated', 'link', 'see', 'since']]]``

- `@Symfony <./../../ruleSets/Symfony.rst>`_ with config:

``['groups' => [['deprecated', 'link', 'see', 'since'], ['author', 'copyright', 'license'], ['category', 'package', 'subpackage'], ['property', 'property-read', 'property-write'], ['Annotation', 'NamedArgumentConstructor', 'Target']]]``
``['groups' => [['Annotation', 'NamedArgumentConstructor', 'Target'], ['author', 'copyright', 'license'], ['category', 'package', 'subpackage'], ['property', 'property-read', 'property-write'], ['deprecated', 'link', 'see', 'since']]]``


2 changes: 1 addition & 1 deletion src/Fixer/Phpdoc/PhpdocSeparationFixer.php
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,10 @@ final class PhpdocSeparationFixer extends AbstractFixer implements ConfigurableF
* @var string[][]
*/
public const OPTION_GROUPS_DEFAULT = [
['deprecated', 'link', 'see', 'since'],
['author', 'copyright', 'license'],
['category', 'package', 'subpackage'],
['property', 'property-read', 'property-write'],
['deprecated', 'link', 'see', 'since'],
];

/**
Expand Down
2 changes: 1 addition & 1 deletion src/RuleSet/Sets/SymfonySet.php
Original file line number Diff line number Diff line change
Expand Up @@ -169,8 +169,8 @@ public function getRules(): array
'phpdoc_scalar' => true,
'phpdoc_separation' => [
'groups' => [
...PhpdocSeparationFixer::OPTION_GROUPS_DEFAULT,
['Annotation', 'NamedArgumentConstructor', 'Target'],
...PhpdocSeparationFixer::OPTION_GROUPS_DEFAULT,
],
],
'phpdoc_single_line_var_spacing' => true,
Expand Down

0 comments on commit a83d808

Please sign in to comment.