From aff74c72dd9232da74e1005c26679df9b5d2f68a Mon Sep 17 00:00:00 2001 From: Celine Mercier Date: Wed, 10 Jun 2015 15:41:14 +0200 Subject: [PATCH] updated the documentation --- doc/source/guidelines.rst | 12 +++++++++++- doc/source/specialvalues.rst | 2 +- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/doc/source/guidelines.rst b/doc/source/guidelines.rst index eddfde1..7e5f348 100644 --- a/doc/source/guidelines.rst +++ b/doc/source/guidelines.rst @@ -66,6 +66,13 @@ Issue tracking is done using `GitLab `_ 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? ***************** diff --git a/doc/source/specialvalues.rst b/doc/source/specialvalues.rst index fe781c5..c8b8d0e 100644 --- a/doc/source/specialvalues.rst +++ b/doc/source/specialvalues.rst @@ -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``::