Skip to content

Commit

Permalink
fix percentile docstring (#4888)
Browse files Browse the repository at this point in the history
  • Loading branch information
rcomer authored Aug 3, 2022
1 parent b6b54cf commit 08fe9c1
Showing 1 changed file with 10 additions and 12 deletions.
22 changes: 10 additions & 12 deletions lib/iris/analysis/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -1975,31 +1975,29 @@ def interp_order(length):
A :class:`~iris.analysis.PercentileAggregator` instance that calculates the
percentile over a :class:`~iris.cube.Cube`, as computed by
:func:`scipy.stats.mstats.mquantiles` (default) or :func:`numpy.percentile` (if
fast_percentile_method is True).
``fast_percentile_method`` is True).
**Required** kwargs associated with the use of this aggregator:
Parameters
----------
percent : float or sequence of floats
Percentile rank/s at which to extract value/s.
Additional kwargs associated with the use of this aggregator:
alphap : float
alphap : float, default=1
Plotting positions parameter, see :func:`scipy.stats.mstats.mquantiles`.
Defaults to 1.
betap : float
betap : float, default=1
Plotting positions parameter, see :func:`scipy.stats.mstats.mquantiles`.
Defaults to 1.
fast_percentile_method : bool
fast_percentile_method : bool, default=False
When set to True, uses :func:`numpy.percentile` method as a faster
alternative to the :func:`scipy.stats.mstats.mquantiles` method. An
exception is raised if the data are masked and the missing data tolerance
is not 0. Defaults to False.
is not 0.
kwargs : dict, optional
**kwargs : dict, optional
Passed to :func:`scipy.stats.mstats.mquantiles` or :func:`numpy.percentile`.
**For example**:
Example
-------
To compute the 10th and 90th percentile over *time*::
Expand Down

0 comments on commit 08fe9c1

Please sign in to comment.