From e52454516fb45677dc63d558fa6e1ea27cc50606 Mon Sep 17 00:00:00 2001 From: mloubout Date: Wed, 6 Aug 2025 18:11:12 -0400 Subject: [PATCH] docs: fix mmin/mmax docstring --- devito/builtins/arithmetic.py | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/devito/builtins/arithmetic.py b/devito/builtins/arithmetic.py index a4d6d0c687..82a1be6ea6 100644 --- a/devito/builtins/arithmetic.py +++ b/devito/builtins/arithmetic.py @@ -180,21 +180,25 @@ def inner(f, g): return f.dtype(n.data[0]) +red_doc = lambda func: f""" + Retrieve the {func}imum. + + Parameters + ---------- + f : array_like or Function + Input operand. + """ + + mmin = lambda f: _reduce_func(f, np.min, dv.mpi.MPI.MIN) +mmin.__doc__ = red_doc('min') mmax = lambda f: _reduce_func(f, np.max, dv.mpi.MPI.MAX) +mmax.__doc__ = red_doc('max') @dv.switchconfig(log_level='ERROR') @check_builtins_args def _reduce_func(f, func, mfunc): - """ - Retrieve the maximum. - - Parameters - ---------- - f : array_like or Function - Input operand. - """ if isinstance(f, dv.Constant): return f.data elif isinstance(f, dv.types.dense.DiscreteFunction):