Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit96fb464

Browse files
committed
Merge pull request#2173 from mdboom/docstring-coding-guidelines
[Sprint] Update coding guidelines wrt documentation
2 parents016a4e3 +b79d531 commit96fb464

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

‎doc/devel/coding_guide.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,17 @@ Documentation
6565
* Every new feature should be documented. If it's a new module, don't
6666
forget to add it to the API docs.
6767

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+
6879
* Build the docs and make sure all formatting warnings are addressed.
6980

7081
* See:ref:`documenting-matplotlib` for our documentation style guide.

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp