Browse Source

docs: Show class with unit tests and BC promise info (#7667)

Michael Voříšek 1 year ago
parent
commit
70110ce16b

+ 6 - 3
doc/rules/alias/array_push.rst

@@ -34,7 +34,10 @@ The rule is part of the following rule sets:
 - `@PhpCsFixer:risky <./../../ruleSets/PhpCsFixerRisky.rst>`_
 - `@Symfony:risky <./../../ruleSets/SymfonyRisky.rst>`_
 
-Source class
-------------
+References
+----------
 
-`PhpCsFixer\\Fixer\\Alias\\ArrayPushFixer <./../../../src/Fixer/Alias/ArrayPushFixer.php>`_
+- Fixer class: `PhpCsFixer\\Fixer\\Alias\\ArrayPushFixer <./../../../src/Fixer/Alias/ArrayPushFixer.php>`_
+- Test class: `PhpCsFixer\\Tests\\Fixer\\Alias\\ArrayPushFixerTest <./../../../tests/Fixer/Alias/ArrayPushFixerTest.php>`_
+
+The test class defines officially supported behaviour. Each test case is a part of our backward compatibility promise.

+ 6 - 3
doc/rules/alias/backtick_to_shell_exec.rst

@@ -34,7 +34,10 @@ The rule is part of the following rule sets:
 - `@PhpCsFixer <./../../ruleSets/PhpCsFixer.rst>`_
 - `@Symfony <./../../ruleSets/Symfony.rst>`_
 
-Source class
-------------
+References
+----------
 
-`PhpCsFixer\\Fixer\\Alias\\BacktickToShellExecFixer <./../../../src/Fixer/Alias/BacktickToShellExecFixer.php>`_
+- Fixer class: `PhpCsFixer\\Fixer\\Alias\\BacktickToShellExecFixer <./../../../src/Fixer/Alias/BacktickToShellExecFixer.php>`_
+- Test class: `PhpCsFixer\\Tests\\Fixer\\Alias\\BacktickToShellExecFixerTest <./../../../tests/Fixer/Alias/BacktickToShellExecFixerTest.php>`_
+
+The test class defines officially supported behaviour. Each test case is a part of our backward compatibility promise.

+ 6 - 3
doc/rules/alias/ereg_to_preg.rst

@@ -33,7 +33,10 @@ The rule is part of the following rule sets:
 - `@PhpCsFixer:risky <./../../ruleSets/PhpCsFixerRisky.rst>`_
 - `@Symfony:risky <./../../ruleSets/SymfonyRisky.rst>`_
 
-Source class
-------------
+References
+----------
 
-`PhpCsFixer\\Fixer\\Alias\\EregToPregFixer <./../../../src/Fixer/Alias/EregToPregFixer.php>`_
+- Fixer class: `PhpCsFixer\\Fixer\\Alias\\EregToPregFixer <./../../../src/Fixer/Alias/EregToPregFixer.php>`_
+- Test class: `PhpCsFixer\\Tests\\Fixer\\Alias\\EregToPregFixerTest <./../../../tests/Fixer/Alias/EregToPregFixerTest.php>`_
+
+The test class defines officially supported behaviour. Each test case is a part of our backward compatibility promise.

+ 6 - 3
doc/rules/alias/mb_str_functions.rst

@@ -48,7 +48,10 @@ Example #1
    +$a = mb_stristr($a, $b);
    +$a = mb_strrchr($a, $b);
    +$a = mb_substr_count($a, $b);
-Source class
-------------
+References
+----------
 
-`PhpCsFixer\\Fixer\\Alias\\MbStrFunctionsFixer <./../../../src/Fixer/Alias/MbStrFunctionsFixer.php>`_
+- Fixer class: `PhpCsFixer\\Fixer\\Alias\\MbStrFunctionsFixer <./../../../src/Fixer/Alias/MbStrFunctionsFixer.php>`_
+- Test class: `PhpCsFixer\\Tests\\Fixer\\Alias\\MbStrFunctionsFixerTest <./../../../tests/Fixer/Alias/MbStrFunctionsFixerTest.php>`_
+
+The test class defines officially supported behaviour. Each test case is a part of our backward compatibility promise.

+ 6 - 3
doc/rules/alias/modernize_strpos.rst

@@ -42,7 +42,10 @@ The rule is part of the following rule sets:
 - `@PHP80Migration:risky <./../../ruleSets/PHP80MigrationRisky.rst>`_
 - `@Symfony:risky <./../../ruleSets/SymfonyRisky.rst>`_
 
-Source class
-------------
+References
+----------
 
-`PhpCsFixer\\Fixer\\Alias\\ModernizeStrposFixer <./../../../src/Fixer/Alias/ModernizeStrposFixer.php>`_
+- Fixer class: `PhpCsFixer\\Fixer\\Alias\\ModernizeStrposFixer <./../../../src/Fixer/Alias/ModernizeStrposFixer.php>`_
+- Test class: `PhpCsFixer\\Tests\\Fixer\\Alias\\ModernizeStrposFixerTest <./../../../tests/Fixer/Alias/ModernizeStrposFixerTest.php>`_
+
+The test class defines officially supported behaviour. Each test case is a part of our backward compatibility promise.

+ 6 - 3
doc/rules/alias/no_alias_functions.rst

@@ -127,7 +127,10 @@ The rule is part of the following rule sets:
 
 - `@Symfony:risky <./../../ruleSets/SymfonyRisky.rst>`_
 
-Source class
-------------
+References
+----------
 
-`PhpCsFixer\\Fixer\\Alias\\NoAliasFunctionsFixer <./../../../src/Fixer/Alias/NoAliasFunctionsFixer.php>`_
+- Fixer class: `PhpCsFixer\\Fixer\\Alias\\NoAliasFunctionsFixer <./../../../src/Fixer/Alias/NoAliasFunctionsFixer.php>`_
+- Test class: `PhpCsFixer\\Tests\\Fixer\\Alias\\NoAliasFunctionsFixerTest <./../../../tests/Fixer/Alias/NoAliasFunctionsFixerTest.php>`_
+
+The test class defines officially supported behaviour. Each test case is a part of our backward compatibility promise.

+ 6 - 3
doc/rules/alias/no_alias_language_construct_call.rst

@@ -26,7 +26,10 @@ The rule is part of the following rule sets:
 - `@PhpCsFixer <./../../ruleSets/PhpCsFixer.rst>`_
 - `@Symfony <./../../ruleSets/Symfony.rst>`_
 
-Source class
-------------
+References
+----------
 
-`PhpCsFixer\\Fixer\\Alias\\NoAliasLanguageConstructCallFixer <./../../../src/Fixer/Alias/NoAliasLanguageConstructCallFixer.php>`_
+- Fixer class: `PhpCsFixer\\Fixer\\Alias\\NoAliasLanguageConstructCallFixer <./../../../src/Fixer/Alias/NoAliasLanguageConstructCallFixer.php>`_
+- Test class: `PhpCsFixer\\Tests\\Fixer\\Alias\\NoAliasLanguageConstructCallFixerTest <./../../../tests/Fixer/Alias/NoAliasLanguageConstructCallFixerTest.php>`_
+
+The test class defines officially supported behaviour. Each test case is a part of our backward compatibility promise.

+ 6 - 3
doc/rules/alias/no_mixed_echo_print.rst

@@ -51,7 +51,10 @@ The rule is part of the following rule sets:
 - `@PhpCsFixer <./../../ruleSets/PhpCsFixer.rst>`_
 - `@Symfony <./../../ruleSets/Symfony.rst>`_
 
-Source class
-------------
+References
+----------
 
-`PhpCsFixer\\Fixer\\Alias\\NoMixedEchoPrintFixer <./../../../src/Fixer/Alias/NoMixedEchoPrintFixer.php>`_
+- Fixer class: `PhpCsFixer\\Fixer\\Alias\\NoMixedEchoPrintFixer <./../../../src/Fixer/Alias/NoMixedEchoPrintFixer.php>`_
+- Test class: `PhpCsFixer\\Tests\\Fixer\\Alias\\NoMixedEchoPrintFixerTest <./../../../tests/Fixer/Alias/NoMixedEchoPrintFixerTest.php>`_
+
+The test class defines officially supported behaviour. Each test case is a part of our backward compatibility promise.

+ 6 - 3
doc/rules/alias/pow_to_exponentiation.rst

@@ -39,7 +39,10 @@ The rule is part of the following rule sets:
 - `@PhpCsFixer:risky <./../../ruleSets/PhpCsFixerRisky.rst>`_
 - `@Symfony:risky <./../../ruleSets/SymfonyRisky.rst>`_
 
-Source class
-------------
+References
+----------
 
-`PhpCsFixer\\Fixer\\Alias\\PowToExponentiationFixer <./../../../src/Fixer/Alias/PowToExponentiationFixer.php>`_
+- Fixer class: `PhpCsFixer\\Fixer\\Alias\\PowToExponentiationFixer <./../../../src/Fixer/Alias/PowToExponentiationFixer.php>`_
+- Test class: `PhpCsFixer\\Tests\\Fixer\\Alias\\PowToExponentiationFixerTest <./../../../tests/Fixer/Alias/PowToExponentiationFixerTest.php>`_
+
+The test class defines officially supported behaviour. Each test case is a part of our backward compatibility promise.

+ 6 - 3
doc/rules/alias/random_api_migration.rst

@@ -95,7 +95,10 @@ The rule is part of the following rule sets:
   ``['replacements' => ['mt_rand' => 'random_int', 'rand' => 'random_int']]``
 
 
-Source class
-------------
+References
+----------
 
-`PhpCsFixer\\Fixer\\Alias\\RandomApiMigrationFixer <./../../../src/Fixer/Alias/RandomApiMigrationFixer.php>`_
+- Fixer class: `PhpCsFixer\\Fixer\\Alias\\RandomApiMigrationFixer <./../../../src/Fixer/Alias/RandomApiMigrationFixer.php>`_
+- Test class: `PhpCsFixer\\Tests\\Fixer\\Alias\\RandomApiMigrationFixerTest <./../../../tests/Fixer/Alias/RandomApiMigrationFixerTest.php>`_
+
+The test class defines officially supported behaviour. Each test case is a part of our backward compatibility promise.

Some files were not shown because too many files changed in this diff