diff options
Diffstat (limited to 'docs/contributing.rst')
| -rw-r--r-- | docs/contributing.rst | 15 |
1 files changed, 11 insertions, 4 deletions
diff --git a/docs/contributing.rst b/docs/contributing.rst index 6a76c705..e1475b88 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -117,10 +117,17 @@ Docstrings should be written like this: So, specifically: -- Always use three double quotes. -- Put the three double quotes on their own line. -- No blank line at the end. -- Use Sphinx parameter/attribute documentation `syntax`_. +* Always use three double quotes. +* Put the three double quotes on their own line. +* No blank line at the end. +* Use Sphinx parameter/attribute documentation `syntax`_. + +When documenting a new module in the ``hazmat`` package, its documentation +should begin with the "Hazardous Materials" warning: + +.. code-block:: rest + + .. hazmat:: Development Environment ----------------------- |