From 92a9aa9e333f5cc3d563da8eeae47578252e56bd Mon Sep 17 00:00:00 2001 From: Allan Wollaber Date: Sun, 9 Jul 2023 16:39:37 -0400 Subject: [PATCH] Update test link in CONTRIBUTING.md It looks like the name of the docstrings test (the one where one should place the examples) has changed its name. --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 43c7c4f9..251397ad 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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.