[x ] tox -e style (to run pylint) the code style tests.
[x ] tox -e docs (to run sphinx) generate the documentation.
[x ] Added test for changed/added code.
[ x] API code contributions include input checks (defensive code).
[ x] API code contributions include helpful error messages.
[ x] The documentation has been updated:
[ x] docstring for all new functions/methods/classes/modules.
[x ] consistent style of all docstrings.
[ x] for new modules: /docs/pages/modules.rst has been updated.
[ x] for api contributions: /docs/pages/api.rst has been updated.
[ x] for api contributions: tutorials and examples have been updated.
There will be a separate pull request for the Performance Testing code.
Hope everything is acceptable here. Let me know if any other improvements/fixes could be made.
PT-Gradient
Here is a pull-request for the PT-Gradient code, with modifications according to feedback from Gerald et al.
tox -e py36
(to runpytest
) the code tests.tox -e style
(to runpylint
) the code style tests.tox -e docs
(to runsphinx
) generate the documentation./docs/pages/modules.rst
has been updated./docs/pages/api.rst
has been updated.There will be a separate pull request for the Performance Testing code. Hope everything is acceptable here. Let me know if any other improvements/fixes could be made.
Best, Eoin O.