Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docstring standards #52

Merged
merged 12 commits into from
Apr 22, 2020
Merged

Docstring standards #52

merged 12 commits into from
Apr 22, 2020

Conversation

f-dangel
Copy link
Owner

This PR introduces darglint and pydocstyle as development tools to check existence/completeness/style of docstrings. More notes on development standards are listed in the developer manual.

Add GitHub actions and pre-commit hooks for the following make tasks:

# check docstrings with pydocstyle
make pydocstyle-check 
# check docstrings with darglint
make darglint-check

@f-dangel f-dangel requested a review from fKunstner April 20, 2020 14:14
@fKunstner fKunstner merged commit 1ac4c45 into development Apr 22, 2020
@fKunstner fKunstner deleted the docstring-standards branch April 27, 2020 05:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fKunstner fKunstner Awaiting requested review from fKunstner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@f-dangel @fKunstner