Skip to content

Commit

Permalink
fix typos (#73)
Browse files Browse the repository at this point in the history
* fix typo

* typo indenttion => indentation
  • Loading branch information
AnaelMobilia authored and trasher committed Jan 2, 2018
1 parent 4a99208 commit f6fdd30
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions source/codingstandards.rst
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ This tag usage is not forbidden, but make sure to use it properly, or just avoid
[...]
}
Something we can see quite often is just the usage of the ``@see`` tag to make reference to the parent method. **This is wrong**. The ``@see`` tag is designed to reference another method that would help to understand this one; not to make a reference to its parent (you can alos take a look at `PHPDocumentor documentation about it <https://www.phpdoc.org/docs/latest/references/phpdoc/tags/see.html>`_. While generating, parent class and methods are automaticaly discovered; a link to the parent will be automatically added.
Something we can see quite often is just the usage of the ``@see`` tag to make reference to the parent method. **This is wrong**. The ``@see`` tag is designed to reference another method that would help to understand this one; not to make a reference to its parent (you can also take a look at `PHPDocumentor documentation about it <https://www.phpdoc.org/docs/latest/references/phpdoc/tags/see.html>`_. While generating, parent class and methods are automaticaly discovered; a link to the parent will be automatically added.
An usage example:

.. code-block:: php
Expand Down Expand Up @@ -426,7 +426,7 @@ Files

* Name in lower case.
* Maximum line length: 100 characters
* Indenttion: 3 spaces
* Indentation: 3 spaces

Database queries
----------------
Expand Down

0 comments on commit f6fdd30

Please sign in to comment.