From b79d5319e4f1f9fe19568da66738fe19a489b2a5 Mon Sep 17 00:00:00 2001 From: Michael Droettboom Date: Sat, 29 Jun 2013 11:01:24 -0400 Subject: [PATCH] Update the coding guidelines wrt to docstrings and MEP10 --- doc/devel/coding_guide.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/doc/devel/coding_guide.rst b/doc/devel/coding_guide.rst index 7273fb38313d..2df6a8cb636d 100644 --- a/doc/devel/coding_guide.rst +++ b/doc/devel/coding_guide.rst @@ -65,6 +65,17 @@ Documentation * Every new feature should be documented. If it's a new module, don't forget to add it to the API docs. +* Docstrings should be in `numpydoc format + `_. + Don't be thrown off by the fact that many of the existing docstrings + are not in that format. We are working to standardize on + `numpydoc`. + +* Each high-level plotting function should have a simple example in + the `Example` section. This should be as simple as possible to + demonstrate the method. More complex examples should go in the + `examples` tree. + * Build the docs and make sure all formatting warnings are addressed. * See :ref:`documenting-matplotlib` for our documentation style guide.