From 05a190ee80dd57461c493f3a4a79a072612d3622 Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Tue, 29 Oct 2013 17:11:25 -0700 Subject: Document that you should use the hazmat directive --- docs/contributing.rst | 15 +++++++++++---- 1 file 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 ----------------------- -- cgit v1.2.3