Skip to content
This repository has been archived by the owner on Nov 29, 2023. It is now read-only.

Format docstrings so they pass pydocstyle's criteria #97

Open
JackKelly opened this issue Sep 16, 2021 · 2 comments
Open

Format docstrings so they pass pydocstyle's criteria #97

JackKelly opened this issue Sep 16, 2021 · 2 comments
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 PR showing the errors from the linter for SatFlow is here: #96

@jacobbieker
Copy link
Member

Also, any updates should probably wait for #94 to be merged, as that removes ~5400 lines of code and a ton of files, and shrinks SatFlow a lot

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants