Skip to content

Commit

Permalink
Fixed typo in the contributing guidelines (#3035)
Browse files Browse the repository at this point in the history
* Fix typo in pre-commit

* Fix markdown syntax for gogle docstring style hyperlink
  • Loading branch information
danielykim committed Aug 21, 2022
1 parent 1061949 commit 78c3faa
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Expand Up @@ -45,11 +45,11 @@ Additionally, for pull requests, the project runs a number of tests for the whol
These tests can be run locally with `pytest` in the root folder.

## Docstrings
Pydocstyle has been added to the pre-commit process such that all new functions follow the (google docstring style)[https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html].
Pydocstyle has been added to the pre-commit process such that all new functions follow the [google docstring style](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html).
All new functions require either a short docstring, a single line explaining the purpose of a function
or a multiline docstring that documents each argument and the return type (if there is one) of the function.
In addition, new file and class require top docstrings that should outline the purpose of the file/class.
For classes, code block examples can be provided in the top docstring and not the constructor arguments.

To check your docstrings are correct, run `pre-commit run --al-files` or `pydocstyle --source --explain --convention=google`.
To check your docstrings are correct, run `pre-commit run --all-files` or `pydocstyle --source --explain --convention=google`.
If all docstrings that fail, the source and reason for the failure is provided.

0 comments on commit 78c3faa

Please sign in to comment.