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

Format docstrings so they pass pydocstyle's criteria #2

Open
JackKelly opened this issue Sep 16, 2021 · 1 comment
Open

Format docstrings so they pass pydocstyle's criteria #2

JackKelly opened this issue Sep 16, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@JackKelly
Copy link
Member

Detailed Description

We plan to use pydocstyle to automatically check that our docstrings conform to a standard format. It would be amazing to have help tweaking our existing docstrings to conform!

pydocstyle's list of criteria is here: http://www.pydocstyle.org/en/stable/error_codes.html

Here's the Pull Request (and discussion) about enabling pydocstyle for nowcasting_utils: openclimatefix/nowcasting_utils#23
@JackKelly JackKelly added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Sep 16, 2021
@jacobbieker
Copy link
Member

The linter has also been added to SkillFul Nowcasting, so the errors will show up here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@JackKelly @jacobbieker