Skip to content

Commit

Permalink
Remove extra space
Browse files Browse the repository at this point in the history
  • Loading branch information
@lochhh
lochhh committed Jul 2, 2024
1 parent f84f2c5 commit 4b41160
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ Information on specific functions, classes, and methods.
```

The API reference is auto-generated by the `sphinx-autodoc` and `sphinx-autosummary` plugins, based on docstrings.
So make sure that all your public functions/classes/methods have valid docstrings following the [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) style.
So make sure that all your public functions/classes/methods have valid docstrings following the [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) style.
Our `pre-commit` hooks include some checks (`ruff` rules) that ensure the docstrings are formatted consistently.

### Updating the examples
Expand Down

0 comments on commit 4b41160

Please sign in to comment.