🌐 AI搜索 & 代理 主页
Skip to content

[Sprint] Update coding guidelines wrt documentation #2173

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelson merged 1 commit into from
Jun 29, 2013
Merged

[Sprint] Update coding guidelines wrt documentation #2173

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions doc/devel/coding_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
<https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt>`_.
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.
Expand Down