Standardize documentation style with darglint
#70
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds the
darglint
plugin forflake8
, whose job it is to check that documentation is provided in the correct format.Changes
darglint
to theflake8
environment intox.ini
darglint
configuration insetup.cfg
where I setsphinx
as the preferred style for chemicalx. Previously, people looked towards the numpy and google styles since they helped reduce clutter, at the cost of taking a huge number of lines and leaving tons of dead whitespace. Now that type hints are first class in the python langauge, these formats seem a bit too verbose and the sphinx style is now best again