Correct generate_ororgraphic_smoothing_coefficients doc-string #1999
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 (
ancientsurprisingly young) PR changed thegenerate_orographic_smoothing_coefficients
method so that it no longer required acoefficient
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 acoefficient
in the CLI doc-string remains. This PR removes that reference.