From cc53cf54d69ddec7d907f145f012ec1c5c1e59b9 Mon Sep 17 00:00:00 2001
From: lenkis <elena.shebunyaeva@gmail.com>
Date: Mon, 6 Jun 2016 15:35:43 +0300
Subject: [PATCH] Added recent agreements.
---
doc/sphinx/dev_guide/documentation_guidelines.rst | 13 +++++--------
1 file changed, 5 insertions(+), 8 deletions(-)
diff --git a/doc/sphinx/dev_guide/documentation_guidelines.rst b/doc/sphinx/dev_guide/documentation_guidelines.rst
index 382793e90e..dabd527576 100644
--- a/doc/sphinx/dev_guide/documentation_guidelines.rst
+++ b/doc/sphinx/dev_guide/documentation_guidelines.rst
@@ -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.
--
GitLab