link percentile as lazy option (#5128)

SciTools · Jan 4, 2023 · f190415 · f190415
1 parent fc302c9
commit f190415
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/docs/src/whatsnew/latest.rst b/docs/src/whatsnew/latest.rst
@@ -69,6 +69,10 @@ This document explains the changes made to Iris for this release
 
 #. `@rcomer`_ clarified instructions for updating gallery tests. (:pull:`5100`)
 
+#. `@rcomer`_ linked the :obj:`~iris.analysis.PERCENTILE` aggregator from the
+   :obj:`~iris.analysis.MEDIAN` docstring, noting that the former handles lazy
+   data. (:pull:`5128`)
+
 
 💼 Internal
 ===========

diff --git a/lib/iris/analysis/__init__.py b/lib/iris/analysis/__init__.py
@@ -1914,7 +1914,8 @@ def interp_order(length):
 
     result = cube.collapsed('longitude', iris.analysis.MEDIAN)
 
-This aggregator handles masked data, but NOT lazy data.
+This aggregator handles masked data, but NOT lazy data.  For lazy aggregation,
+please try :obj:`~.PERCENTILE`.
 
 """