From eec543088600d33b6832438479c8def7a55aac51 Mon Sep 17 00:00:00 2001 From: Ruth Comer Date: Wed, 4 Jan 2023 16:11:32 +0000 Subject: [PATCH] link percentile as lazy option --- docs/src/whatsnew/latest.rst | 4 ++++ lib/iris/analysis/__init__.py | 3 ++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/src/whatsnew/latest.rst b/docs/src/whatsnew/latest.rst index d1aae76675..2029e24855 100644 --- 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 index c0f9b5b0f8..55d5d5d93e 100644 --- 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`. """