Unverified Commit 22a8fbd7 authored by Bharath Ramsundar's avatar Bharath Ramsundar Committed by GitHub
Browse files

Merge pull request #2651 from Suzukazole/docupdate

Update PR template and docs with doctest, pytest
parents f7401f34 4fe48b45
...@@ -25,6 +25,7 @@ Please check the option that is related to your PR. ...@@ -25,6 +25,7 @@ Please check the option that is related to your PR.
- [ ] Run `yapf -i <modified file>` and check no errors (**yapf version must be 0.22.0**) - [ ] Run `yapf -i <modified file>` and check no errors (**yapf version must be 0.22.0**)
- [ ] Run `mypy -p deepchem` and check no errors - [ ] Run `mypy -p deepchem` and check no errors
- [ ] Run `flake8 <modified file> --count` and check no errors - [ ] Run `flake8 <modified file> --count` and check no errors
- [ ] Run `python -m doctest <modified file>` and check no errors
- [ ] I have performed a self-review of my own code - [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation - [ ] I have made corresponding changes to the documentation
......
...@@ -40,7 +40,7 @@ Whenever you modify a file, run :code:`flake8` on it. ...@@ -40,7 +40,7 @@ Whenever you modify a file, run :code:`flake8` on it.
flake8 <modified file> --count flake8 <modified file> --count
If the command return 0, it means your code pass Flake8 check. If the command returns 0, it means your code passes the Flake8 check.
Docstrings Docstrings
---------- ----------
...@@ -53,8 +53,12 @@ appropriate, cite the relevant publications. ...@@ -53,8 +53,12 @@ appropriate, cite the relevant publications.
.. _`numpy`: https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard .. _`numpy`: https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard
All docstrings should follow the `numpy`_ docstring formatting conventions. All docstrings should follow the `numpy`_ docstring formatting conventions. To
ensure that the code examples in the docstrings are working as expected, run
.. code-block:: bash
python -m doctest <modified file>
Unit Tests Unit Tests
---------- ----------
...@@ -91,6 +95,12 @@ while installing the package from source. This will let you see changes that you ...@@ -91,6 +95,12 @@ while installing the package from source. This will let you see changes that you
make to the source code when you import the package and, in particular, it make to the source code when you import the package and, in particular, it
allows you to import the new classes/methods for unit tests. allows you to import the new classes/methods for unit tests.
Ensure that the tests pass locally! Check this by running
.. code-block:: bash
python -m pytest <modified file>
Testing Machine Learning Models Testing Machine Learning Models
------------------------------- -------------------------------
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment