Format docstrings so they pass `pydocstyle`'s criteria

openclimatefix / metnet

PyTorch Implementation of Google Research's MetNet and MetNet-2

MIT License

233 stars 47 forks source link

Format docstrings so they pass `pydocstyle`'s criteria #1

Open JackKelly opened 2 years ago

JackKelly commented 2 years ago

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

jacobbieker commented 2 years ago

The PR in MetNet showing the errors is here #2