BUGFIX: Broken documentation
* Fix broken links * Fix broken syntax Relates: #63
This commit is contained in:
parent
d15388849e
commit
c87546de29
2 changed files with 4 additions and 3 deletions
|
@ -29,7 +29,7 @@ make sure to check your coding style with `phpcs`_.
|
||||||
|
|
||||||
New sniffs have to be covered by tests, see :ref:`extending-tests`.
|
New sniffs have to be covered by tests, see :ref:`extending-tests`.
|
||||||
|
|
||||||
.. _TYPO3 slack: https://typo3.slack.com/messages/@danielsiepmann
|
.. _TYPO3 slack: https://typo3.slack.com/?redir=%2Fmessages%2F%40danielsiepmann
|
||||||
.. _docker: https://www.docker.com/
|
.. _docker: https://www.docker.com/
|
||||||
.. _phpcs: https://github.com/squizlabs/PHP_CodeSniffer
|
.. _phpcs: https://github.com/squizlabs/PHP_CodeSniffer
|
||||||
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
|
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
|
||||||
|
|
|
@ -14,7 +14,7 @@ Sniffs
|
||||||
------
|
------
|
||||||
|
|
||||||
Follow the official docs of `phpcs`_:
|
Follow the official docs of `phpcs`_:
|
||||||
https://github.com/squizlabs/PHP_CodeSniffer/wiki/Coding-Standard-Tutorial#creating-the-sniff
|
https://github.com/squizlabs/PHP_CodeSniffer/wiki/Coding-Standard-Tutorial#user-content-creating-the-sniff
|
||||||
|
|
||||||
The following resources might be helpful during working with ``phpcs``:
|
The following resources might be helpful during working with ``phpcs``:
|
||||||
|
|
||||||
|
@ -61,6 +61,7 @@ like options for the sniff. In that case you have to place a :file:`Arguments.ph
|
||||||
This file returns an array:
|
This file returns an array:
|
||||||
|
|
||||||
.. code-block:: php
|
.. code-block:: php
|
||||||
|
|
||||||
<?php
|
<?php
|
||||||
|
|
||||||
return [
|
return [
|
||||||
|
@ -72,7 +73,7 @@ This file returns an array:
|
||||||
],
|
],
|
||||||
];
|
];
|
||||||
|
|
||||||
In the example above ``defaultVendor`` and ``customVendor` are subfolders containing the same
|
In the example above ``defaultVendor`` and ``customVendor`` are subfolders containing the same
|
||||||
structure as documented for :ref:`extending-tests-single`.
|
structure as documented for :ref:`extending-tests-single`.
|
||||||
This way it's possible to run multiple tests per sniff.
|
This way it's possible to run multiple tests per sniff.
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue