earthobservations / wetterdienst

Open weather data for humans.
https://wetterdienst.readthedocs.io/
MIT License
349 stars 54 forks source link

docstring doesn't match method signature #1234

Closed donni-h closed 6 months ago

donni-h commented 6 months ago

Make docstring match typehints.

I am working with the DWD at work and we've written our own parser (though much less sophisticated). Stumbling upon this project, it looks very promising (I wasn't even aware of Polars before!). :)

I read through some of the code to understand what the library is doing, and I noticed that the docstring didn't match the actual function typehints (Did you change from pandas -> polars at some point?)

There might be more documentation where this is the case. If there is a misunderstanding on my end, please let me know. Thanks for the work you've put into this! <3

codecov[bot] commented 6 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 90.83%. Comparing base (6d06232) to head (c064b65). Report is 66 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #1234 +/- ## ========================================== - Coverage 90.85% 90.83% -0.03% ========================================== Files 103 103 Lines 9856 9865 +9 Branches 1133 1065 -68 ========================================== + Hits 8955 8961 +6 - Misses 703 709 +6 + Partials 198 195 -3 ``` | [Flag](https://app.codecov.io/gh/earthobservations/wetterdienst/pull/1234/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=earthobservations) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/earthobservations/wetterdienst/pull/1234/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=earthobservations) | `90.83% <ø> (-0.03%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=earthobservations#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

gutzbenj commented 6 months ago

Dear @donni-h ,

wow that sounds exciting! What's the topic of the project? I remember working in a project of the university together with the DWD and the data transfer was a huge thing but nowadays, everybody can just get the data themselves from the server! What a beautiful commitment of DWD to open data!

You are right about the change from pandas to polars! We did this mainly for the speed improvement (using pandas the Python process could run out of ram (and time LOL) when getting 1 minute precipitation data (which is some millions of rows in total)) but it actually also has a much cleaner interface for most of the transformations, much closer to common SQL tasks!

Thanks for the PR! I will merge it and probably it's time to go through all the code and see if copilot can improve the docstrings :-D