Skip to content

Commit

Permalink
Add note in CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
pelletier committed Feb 14, 2024
1 parent 59ca505 commit bf45a97
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,16 @@ click around. You can refresh your browser after each `make coverage` run.

Formatting is done with `black`. Run `make fmt`.

Docstrings follow the [Google style][docstrings].
Docstrings follow the [Google style][docstrings]. All public entities should
have a docstring attached.

[docstrings]: https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings

## Documentation

API reference documentation is automatically built on merges to `main` and new
tagged version. To view the generated documentation locally:

```
make local-docs
```

0 comments on commit bf45a97

Please sign in to comment.