skillful_nowcasting icon indicating copy to clipboard operation
skillful_nowcasting copied to clipboard

Format docstrings so they pass `pydocstyle`'s criteria

Open JackKelly opened this issue 2 years ago • 1 comments

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: https://github.com/openclimatefix/nowcasting_utils/pull/23

JackKelly avatar Sep 16 '21 15:09 JackKelly

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

jacobbieker avatar Sep 16 '21 15:09 jacobbieker