From 341cc916fc9f7b76d4f95f9052d26546ff717206 Mon Sep 17 00:00:00 2001 From: tuhinsharma121 Date: Sat, 4 May 2024 19:24:34 +0530 Subject: [PATCH 1/2] DOC: add RT03 for pandas.Series.max --- pandas/core/series.py | 60 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 59 insertions(+), 1 deletion(-) diff --git a/pandas/core/series.py b/pandas/core/series.py index 8474fd0d74919..8ee32d915420b 100644 --- a/pandas/core/series.py +++ b/pandas/core/series.py @@ -6157,7 +6157,6 @@ def min( ) @deprecate_nonkeyword_arguments(version="3.0", allowed_args=["self"], name="max") - @doc(make_doc("max", ndim=1)) def max( self, axis: Axis | None = 0, @@ -6165,6 +6164,65 @@ def max( numeric_only: bool = False, **kwargs, ): + """ + Return the maximum of the values over the requested axis. + + If you want the *index* of the maximum, use ``idxmax``. + This is the equivalent of the ``numpy.ndarray`` method ``argmax``. + + Parameters + ---------- + axis : {index (0)} + Axis for the function to be applied on. + For `Series` this parameter is unused and defaults to 0. + + For DataFrames, specifying ``axis=None`` will apply the aggregation + across both axes. + + .. versionadded:: 2.0.0 + + skipna : bool, default True + Exclude NA/null values when computing the result. + numeric_only : bool, default False + Include only float, int, boolean columns. + **kwargs + Additional keyword arguments to be passed to the function. + + Returns + ------- + scalar or Series (if level specified) + The maximum of the values in the Series. + + See Also + -------- + numpy.max : Equivalent numpy function for arrays. + Series.min : Return the minimum. + Series.max : Return the maximum. + Series.idxmin : Return the index of the minimum. + Series.idxmax : Return the index of the maximum. + DataFrame.min : Return the minimum over the requested axis. + DataFrame.max : Return the maximum over the requested axis. + DataFrame.idxmin : Return the index of the minimum over the requested axis. + DataFrame.idxmax : Return the index of the maximum over the requested axis. + + Examples + -------- + >>> idx = pd.MultiIndex.from_arrays( + ... [["warm", "warm", "cold", "cold"], ["dog", "falcon", "fish", "spider"]], + ... names=["blooded", "animal"], + ... ) + >>> s = pd.Series([4, 2, 0, 8], name="legs", index=idx) + >>> s + blooded animal + warm dog 4 + falcon 2 + cold fish 0 + spider 8 + Name: legs, dtype: int64 + + >>> s.max() + 8 + """ return NDFrame.max( self, axis=axis, skipna=skipna, numeric_only=numeric_only, **kwargs ) From 52403a431fbdef9efef4637e99209ae299614a7c Mon Sep 17 00:00:00 2001 From: tuhinsharma121 Date: Sat, 4 May 2024 19:25:11 +0530 Subject: [PATCH 2/2] DOC: remove RT03 for pandas.Series.max --- ci/code_checks.sh | 1 - 1 file changed, 1 deletion(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 936e3664cfe93..d970e2f72c965 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -207,7 +207,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then -i "pandas.Series.list.flatten SA01" \ -i "pandas.Series.list.len SA01" \ -i "pandas.Series.lt PR07,SA01" \ - -i "pandas.Series.max RT03" \ -i "pandas.Series.mean RT03,SA01" \ -i "pandas.Series.median RT03,SA01" \ -i "pandas.Series.min RT03" \