Attempt at defining some naming conventions.
This commit is contained in:
@ -63,8 +63,7 @@ Issue tracking
|
|||||||
==============
|
==============
|
||||||
|
|
||||||
Issue tracking is done using `GitLab <https://about.gitlab.com/>`_ at http://git.metabarcoding.org/.
|
Issue tracking is done using `GitLab <https://about.gitlab.com/>`_ at http://git.metabarcoding.org/.
|
||||||
Creating a branch should always lead to the creation of a label that refers to it in GitLab.
|
Tickets should always be labeled with the branches for which they are relevant.
|
||||||
Tickets should always be labelled with the branches for which they are relevant.
|
|
||||||
|
|
||||||
|
|
||||||
**************
|
**************
|
||||||
@ -99,8 +98,20 @@ in the Sphinx documentation using `Breathe <https://breathe.readthedocs.org/en/l
|
|||||||
Naming conventions
|
Naming conventions
|
||||||
******************
|
******************
|
||||||
|
|
||||||
.. todo::
|
Struct, Enum: ``Title_case``
|
||||||
Look for common naming conventions
|
|
||||||
|
Enum members, macros, constants: ``ALL_CAPS``
|
||||||
|
|
||||||
|
Functions, local variables: ``lower_case``
|
||||||
|
|
||||||
|
Functions that shouldn't be called directly: ``_lower_case`` (``_`` prefix)
|
||||||
|
|
||||||
|
Global variables: ``g_lower_case`` (``g_`` prefix)
|
||||||
|
|
||||||
|
Pointers: ``pointer_ptr`` (``_ptr`` suffix)
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
Underscores are used to delimit words.
|
||||||
|
|
||||||
|
|
||||||
*****************
|
*****************
|
||||||
|
Reference in New Issue
Block a user