@@ -10,16 +10,21 @@ Conventions
1010There are a few conventions that should be followed
1111when writing docstrings within the code:
1212
13- - Docstrings should follow `Google Style Documentation
14- <http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html> `__.
13+ - Docstrings should follow
14+ `Google Style Documentation
15+ <http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html> `__.
16+
1517- Do not say "**defaults to ____ **" for any arguments,
16- unless the argument needs further explanation.
17- The default value is already available in the method/function definition.
18- - If function needs to be instantiated, explicitly show in example. See
19- `here <https://stackoverflow.com/questions/17134653/difference-between-class-and-instance-methods >`__
20- for discussion of class vs instance methods.
18+ unless the argument needs further explanation.
19+ The default value is already available in the method/function definition.
20+
21+ - If function needs to be instantiated, explicitly show in example.
22+ See
23+ `here <https://stackoverflow.com/questions/17134653/difference-between-class-and-instance-methods >`__
24+ for discussion of class vs instance methods.
25+
2126- Provide link to `Controlled Vocabulary <http://vocabulary.odm2.org/ >`__
22- if an argument needs a CV as value.
27+ if an argument needs a CV as value.
2328
2429Please add any additional conventions that you think should be in place
2530within `the github issue #106 <https://github.com/ODM2/ODM2PythonAPI/issues/106 >`__.
0 commit comments