diff --git a/docs/source/contribute.rst b/docs/source/contribute.rst index 5512351..25103c0 100644 --- a/docs/source/contribute.rst +++ b/docs/source/contribute.rst @@ -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 -`__. +- Docstrings should follow + `Google Style Documentation + `__. + - 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 `__ -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 `__ + for discussion of class vs instance methods. + - Provide link to `Controlled Vocabulary `__ -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 `__.