Skip to content

Commit dfaf365

Browse files
author
y-p
committed
DOC: mention numpydoc docstrings in CONTRIBUTING.md
1 parent e6aaca5 commit dfaf365

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

CONTRIBUTING.md

+1
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ your contribution or address the issue you're having.
3030
- Performance matters. You can use the included "test_perf.sh"
3131
script to make sure your PR does not introduce any performance regressions
3232
in the library.
33+
- docstrings follow the [numpydoc](https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt) format.
3334
- **Don't** merge upstream into a branch you're going to submit as a PR,
3435
This can create all sorts of problems. Use "git rebase" instead. This ensures
3536
no merge conflicts occur when you're code is merged by the core team.

0 commit comments

Comments
 (0)