search

metoppv / improver

IMPROVER is a library of algorithms for meteorological post-processing.
http://improver.readthedocs.io/en/latest/
BSD 3-Clause "New" or "Revised" License
103 stars 85 forks source link

Correct generate_ororgraphic_smoothing_coefficients doc-string #1999

Closed brhooper closed 4 months ago

brhooper commented 4 months ago

As an IMPROVER scientist, I like it when equations in doc-strings accurately represent the actual calculations being carried out, rather than bamboozling me.

This (~ancient~ surprisingly young) PR changed the generate_orographic_smoothing_coefficients method so that it no longer required a coefficient to be specified, but rather normalised the calculated smoothing coefficients between user specified min and max values. The plugin doc-strings were updated accordingly, but a vestigial reference to a coefficient in the CLI doc-string remains. This PR removes that reference.

codecov[bot] commented 4 months ago

Codecov Report

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

Project coverage is 98.41%. Comparing base (84a8944) to head (3a3de5f). Report is 6 commits behind head on master.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #1999 +/- ## ========================================== + Coverage 98.39% 98.41% +0.01% ========================================== Files 124 124 Lines 12212 12337 +125 ========================================== + Hits 12016 12141 +125 Misses 196 196 ```

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