Skip to content
Snippets Groups Projects
Commit cc53cf54 authored by lenkis's avatar lenkis
Browse files

Added recent agreements.

parent 45486015
No related branches found
No related tags found
No related merge requests found
......@@ -55,7 +55,11 @@ all nested content that follows in the method description).
Language and style issues
===========================================================
*TBD (to be discussed)*
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
US vs British spelling
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
We use English US spelling.
===========================================================
Examples and templates
......@@ -111,17 +115,10 @@ Here is an example of documenting a module (``my_box.index``), a class
.. method:: rename(index-name)
Rename an index.
*Here follow 2 different notations for the same set of parameters.*
:param index_object: an object reference
:param index_name: a new name for the index (type = string)
Parameters:
* :samp:`{index_object}` = an object reference;
* :samp:`{index-name}` (type = string) = new name for index.
:return: nil
Possible errors: index_object does not exist.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment