search

openclimatefix / predict_pv_yield

Using optical flow & machine learning to predict PV yield
MIT License
51 stars 11 forks source link

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

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

mfrasco commented 2 years ago

Hi! I'm a data scientist living in Seattle, USA. I am looking to get more involved in open source projects tackling the climate crisis. I think that your project is really interesting, and I'd love to help you by working on this issue (and perhaps the similar issues in other repos). Would you be open to this contribution from me?

JackKelly commented 2 years ago

Hey! Thanks so much for getting in touch! We'd definitely welcome your contributions!

On this specific issue, I should check something: @jacobbieker & @peterdudfield are we still planning to use pydocstyle; and do predict_pv_yield's docstrings still need to be updated?!

peterdudfield commented 2 years ago

Hi @mfrasco, thanks for getting involved.

@JackKelly yes we are still planning to use pydocstyle. This has been implemented for Nowcasting_dataset and Nowcasting_utils. And yes 'predict_pv_yield' does need updating

It looks like work on a big 'joint' model (https://github.com/openclimatefix/satflow/issues/101) has started in Satflow. Perhaps it would be good to add 'pydocstyle' to this repo first. I mention this so that the work for this issue is most useful.

Thoughts?

JackKelly commented 2 years ago

Sure, sounds good! @mfrasco would you be happy to work on https://github.com/openclimatefix/satflow/issues/97? (Which is still formatting docstrings; but in the SatFlow repo!)

mfrasco commented 2 years ago

Definitely! I can do that.

JackKelly commented 2 years ago

Fantastic, thank you!

peterdudfield commented 2 years ago

Thanks very much @mfrasco

jacobbieker commented 2 years ago

Thanks @mfrasco! I can also help with a lot of the SatFlow stuff, if any of it is confusing!