Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
keradus committed Jan 18, 2021
1 parent a6329f5 commit 6542f87
Show file tree
Hide file tree
Showing 6 changed files with 80 additions and 1 deletion.
12 changes: 12 additions & 0 deletions doc/ruleSets/PHP54Migration.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
============================
Rule set ``@PHP54Migration``
============================

Rules to improve code for PHP 5.6 compatibility.

Rules
-----

- `array_syntax <./../rules/array_notation/array_syntax.rst>`_
config:
``['syntax' => 'short']``
5 changes: 4 additions & 1 deletion doc/ruleSets/PHP56Migration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,7 @@ Rule set ``@PHP56Migration``

Rules to improve code for PHP 5.6 compatibility.

This is an empty set.
Rules
-----

- `@PHP54Migration <./PHP54Migration.rst>`_
3 changes: 3 additions & 0 deletions doc/ruleSets/PHP71Migration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ Rules
-----

- `@PHP70Migration <./PHP70Migration.rst>`_
- `list_syntax <./../rules/list_notation/list_syntax.rst>`_
config:
``['syntax' => 'short']``
- `visibility_required <./../rules/class_notation/visibility_required.rst>`_
config:
``['elements' => ['const', 'method', 'property']]``
1 change: 1 addition & 0 deletions doc/ruleSets/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
List of Available Rule sets
===========================
- `@DoctrineAnnotation <./DoctrineAnnotation.rst>`_
- `@PHP54Migration <./PHP54Migration.rst>`_
- `@PHP56Migration <./PHP56Migration.rst>`_
- `@PHP56Migration:risky <./PHP56MigrationRisky.rst>`_
- `@PHP70Migration <./PHP70Migration.rst>`_
Expand Down
35 changes: 35 additions & 0 deletions doc/rules/array_notation/array_syntax.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,41 @@ Rule sets

The rule is part of the following rule sets:

@PHP54Migration
Using the `@PHP54Migration <./../../ruleSets/PHP54Migration.rst>`_ rule set will enable the ``array_syntax`` rule with the config below:

``['syntax' => 'short']``

@PHP56Migration
Using the `@PHP56Migration <./../../ruleSets/PHP56Migration.rst>`_ rule set will enable the ``array_syntax`` rule with the config below:

``['syntax' => 'short']``

@PHP70Migration
Using the `@PHP70Migration <./../../ruleSets/PHP70Migration.rst>`_ rule set will enable the ``array_syntax`` rule with the config below:

``['syntax' => 'short']``

@PHP71Migration
Using the `@PHP71Migration <./../../ruleSets/PHP71Migration.rst>`_ rule set will enable the ``array_syntax`` rule with the config below:

``['syntax' => 'short']``

@PHP73Migration
Using the `@PHP73Migration <./../../ruleSets/PHP73Migration.rst>`_ rule set will enable the ``array_syntax`` rule with the config below:

``['syntax' => 'short']``

@PHP74Migration
Using the `@PHP74Migration <./../../ruleSets/PHP74Migration.rst>`_ rule set will enable the ``array_syntax`` rule with the config below:

``['syntax' => 'short']``

@PHP80Migration
Using the `@PHP80Migration <./../../ruleSets/PHP80Migration.rst>`_ rule set will enable the ``array_syntax`` rule with the config below:

``['syntax' => 'short']``

@PhpCsFixer
Using the `@PhpCsFixer <./../../ruleSets/PhpCsFixer.rst>`_ rule set will enable the ``array_syntax`` rule with the config below:

Expand Down
25 changes: 25 additions & 0 deletions doc/rules/list_notation/list_syntax.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,28 @@ With configuration: ``['syntax' => 'short']``.
<?php
-list($sample) = $array;
+[$sample] = $array;
Rule sets
---------

The rule is part of the following rule sets:

@PHP71Migration
Using the `@PHP71Migration <./../../ruleSets/PHP71Migration.rst>`_ rule set will enable the ``list_syntax`` rule with the config below:

``['syntax' => 'short']``

@PHP73Migration
Using the `@PHP73Migration <./../../ruleSets/PHP73Migration.rst>`_ rule set will enable the ``list_syntax`` rule with the config below:

``['syntax' => 'short']``

@PHP74Migration
Using the `@PHP74Migration <./../../ruleSets/PHP74Migration.rst>`_ rule set will enable the ``list_syntax`` rule with the config below:

``['syntax' => 'short']``

@PHP80Migration
Using the `@PHP80Migration <./../../ruleSets/PHP80Migration.rst>`_ rule set will enable the ``list_syntax`` rule with the config below:

``['syntax' => 'short']``

0 comments on commit 6542f87

Please sign in to comment.