Skip to content

Commit

Permalink
Merge pull request #505 from mit-ll-responsible-ai/fix-test-link-contrib
Browse files Browse the repository at this point in the history
Update test link in CONTRIBUTING.md
  • Loading branch information
rsokl authored Jul 9, 2023
2 parents 6e7e970 + 92a9aa9 commit 607efeb
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ VSCode's Pylance extension is built off of pyright, and thus is recommended. If

## Adding New Features to the Public API

All functions/classes that are part of the public API must have a docstring that adheres to the [numpy docstring style](https://numpydoc.readthedocs.io/en/latest/format.html), and the docstring must include and `Examples` section. The function's docstring must be scanned by pyright, by adding the function to [this test](https://github.com/mit-ll-responsible-ai/hydra-zen/blob/main/tests/test_docstrings.py).
All functions/classes that are part of the public API must have a docstring that adheres to the [numpy docstring style](https://numpydoc.readthedocs.io/en/latest/format.html), and the docstring must include and `Examples` section. The function's docstring must be scanned by pyright, by adding the function to [this test](https://github.com/mit-ll-responsible-ai/hydra-zen/blob/main/tests/test_documented_examples.py).

All publicly-facing interfaces must be type-annotated and scan "clean" using the pyright type checker.

Expand Down

0 comments on commit 607efeb

Please sign in to comment.