obitools/obitools3
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 66 Wiki Activity

updated the documentation

Browse Source
This commit is contained in:
Celine Mercier
2015-06-10 15:41:14 +02:00
parent 5d967f5b7b
commit aff74c72dd
2 changed files with 12 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
doc/source/guidelines.rst
View File

@ -66,6 +66,13 @@ Issue tracking is done using `GitLab <https://about.gitlab.com/>`_ at http://git
Tickets should always be labeled with the branches for which they are relevant.
*************
Documentation
*************
C functions are documented in the header files.
**************
OBITools3 wiki
**************
@ -111,7 +118,10 @@ Global variables: ``g_lower_case`` (``g_`` prefix
Pointers: ``pointer_ptr`` (``_ptr`` suffix)
.. note::
Underscores are used to delimit words.
Underscores are used to delimit 'words'.
.. todo::
``obi_function`` for public functions names?
*****************

2
doc/source/specialvalues.rst
View File

@ -13,7 +13,7 @@ NA values are implemented by specifying an explicit NA value for each type, corr
* For the type ``OBIChar_t``: the NA value is ``\0`` (?).
* For the type ``OBIStr_t`` : the NA value is a tab followed by a space.
* For the type ``OBIStr_t`` : the NA value is ``\0`` (?).
* For the type ``OBIFloat_t``::