Skip to content

Commit

Permalink
Fix some issues with previous cs docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cconard96 committed Feb 12, 2022
1 parent 655470b commit 3b84595
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions source/coding_standards/javascript.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Starting with GLPI 9.5.0, the target version was bumped to 6 (2015).
Functions
---------

Function names must be written in *camelCaps*:
Function names must be written in *camelCase*:

.. code-block:: JavaScript
Expand All @@ -37,7 +37,7 @@ Classes

If you are writing code for versions of GLPI before 9.5.0, you may not use classes as class support was added in EMCAScript 6.

Class names must be written in `PascalCase`.
Class names must be written in *PascalCase*.

..code-block:: JavaScript

Expand Down
4 changes: 2 additions & 2 deletions source/coding_standards/php.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ For each method or function documentation, you'll need at least to have a descri
//[...]
}
Some other informations way be added; if the function requires it.
Some other information may be added if the function requires it.

Refer to the `PHPDocumentor website <https://phpdoc.org/docs/latest>`_ to get more informations on documentation.

Expand All @@ -95,7 +95,7 @@ Parameters documentation
Each parameter must be documented in its own line, begining with the ``@param`` tag, followed by the `Variables types`_, followed by the param name (``$param``), and finally with the description itself.
If your parameter can be of different types, you can list them separated with a ``|`` or you can use the ``mixed`` type; it's up to you!

All parameters names and description must be aligned vertically on the longest (plu one character); see the above example.
All parameters names and description must be aligned vertically on the longest (plus one character); see the above example.

Override method: @inheritDoc? @see? docblock? no docblock?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down

0 comments on commit 3b84595

Please sign in to comment.