We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see ourdocumentation.
There was an error while loading.Please reload this page.
1 parent58942e0 commite1d391aCopy full SHA for e1d391a
doc/devel/coding_guide.rst
@@ -65,6 +65,17 @@ Documentation
65
* Every new feature should be documented. If it's a new module, don't
66
forget to add it to the API docs.
67
68
+* Docstrings should be in `numpydoc format
69
+<https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt>`_.
70
+ Don't be thrown off by the fact that many of the existing docstrings
71
+ are not in that format. We are working to standardize on
72
+ `numpydoc`.
73
+
74
+* Each high-level plotting function should have a simple example in
75
+ the `Example` section. This should be as simple as possible to
76
+ demonstrate the method. More complex examples should go in the
77
+ `examples` tree.
78
79
* Build the docs and make sure all formatting warnings are addressed.
80
81
* See:ref:`documenting-matplotlib` for our documentation style guide.