Skip to content
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

Jump to bottom

Wrap docstrings to 79 chars and check with flake8 #384

Merged
merged 2 commits into from
Nov 28, 2019
Merged

Wrap docstrings to 79 chars and check with flake8 #384

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2e2cbcf
Wrap docstrings to 79 chars and check with flake8
leouieda Nov 27, 2019
242b7bf
Use current link to numpy style guide
leouieda Nov 28, 2019
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
Prev Previous commit
Use current link to numpy style guide
  • Loading branch information
@leouieda
leouieda committed Nov 28, 2019
commit 242b7bf5addce4bd8e69a647e652fd24b0fa80b6
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ make lint # Runs pylint, which is a bit slower
#### Docstrings

**All docstrings** should follow the
[numpy style guide](https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt).
[numpy style guide](https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard).
All functions/classes/methods should have docstrings with a full description of all
arguments and return values.

Expand Down Expand Up @@ -371,7 +371,7 @@ Sphinx will create a link to the automatically generated page for that
function/class/module.

**All docstrings** should follow the
[numpy style guide](https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt).
[numpy style guide](https://numpydoc.readthedocs.io/en/latest/format.html).
All functions/classes/methods should have docstrings with a full description of all
arguments and return values.

Expand All @@ -390,7 +390,7 @@ Some things that will increase the chance that your pull request is accepted qui
*reason* behind non-obvious things.
* Include an example of new features in the gallery or tutorials.
* Follow the [PEP8](http:https://pep8.org) style guide for code and the
[numpy guide](https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt)
[numpy guide](https://numpydoc.readthedocs.io/en/latest/format.html)
for documentation.

Pull requests will automatically have tests run by TravisCI.
Expand Down