Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions docs/source/contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,21 @@ Conventions
There are a few conventions that should be followed
when writing docstrings within the code:

- Docstrings should follow `Google Style Documentation
<http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html>`__.
- Docstrings should follow
`Google Style Documentation
<http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html>`__.

- Do not say "**defaults to ____**" for any arguments,
unless the argument needs further explanation.
The default value is already available in the method/function definition.
- If function needs to be instantiated, explicitly show in example. See
`here <https://stackoverflow.com/questions/17134653/difference-between-class-and-instance-methods>`__
for discussion of class vs instance methods.
unless the argument needs further explanation.
The default value is already available in the method/function definition.

- If function needs to be instantiated, explicitly show in example.
See
`here <https://stackoverflow.com/questions/17134653/difference-between-class-and-instance-methods>`__
for discussion of class vs instance methods.

- Provide link to `Controlled Vocabulary <http://vocabulary.odm2.org/>`__
if an argument needs a CV as value.
if an argument needs a CV as value.

Please add any additional conventions that you think should be in place
within `the github issue #106 <https://github.com/ODM2/ODM2PythonAPI/issues/106>`__.
Expand Down