-
Notifications
You must be signed in to change notification settings - Fork 3
Open
Description
The docstrings varies between modules in earthkit-meteo and would be great if a common style could be used. E.g. 2 variants:
def cdf(self, x):
"""Evaluate the cumulative distribution function (CDF).
Parameters
----------
x: Number | array_like
Input value.def mixing_ratio_from_vapour_pressure(e, p, eps=1e-4):
r"""Compute the mixing ratio from vapour pressure.
Parameters
----------
e: number or array-like
Vapour pressure (Pa)Other questions:
- does "array-like" also mean number or we always have to use something like "number or array-like" to indicate that an arg/kwarg can be both a number and array?
- what typehint should be used for "array-like"?
Metadata
Metadata
Assignees
Labels
No labels