From 60f8333dda828e8c449dfd73ca8eb3711319beae Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dea=20Mar=C3=ADa=20L=C3=A9on?= Date: Fri, 14 Jul 2023 12:24:49 +0200 Subject: [PATCH 1/2] Added depr note to swapaxes docstrings --- ci/code_checks.sh | 1 - pandas/core/generic.py | 8 ++++++++ 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 0fc8b8217b63f..989ef6958d2e6 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -149,7 +149,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then pandas.api.extensions.ExtensionArray.shape \ pandas.api.extensions.ExtensionArray.tolist \ pandas.DataFrame.pad \ - pandas.DataFrame.swapaxes \ pandas.DataFrame.plot \ pandas.DataFrame.to_gbq \ pandas.DataFrame.__dataframe__ diff --git a/pandas/core/generic.py b/pandas/core/generic.py index 9084395871675..6a066bfee3729 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -771,9 +771,17 @@ def swapaxes(self, axis1: Axis, axis2: Axis, copy: bool_t | None = None) -> Self """ Interchange axes and swap values axes appropriately. + .. deprecated:: 2.1.0 + ``swapaxes`` will be deprecated. + Please use ``transpose`` instead. + Returns ------- same as input + + Examples + -------- + Please see examples for :meth:`DataFrame.transpose`. """ warnings.warn( # GH#51946 From 4c0c3959524ca4b644c06bcf401fca1c45764020 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dea=20Mar=C3=ADa=20L=C3=A9on?= Date: Fri, 14 Jul 2023 13:01:45 +0200 Subject: [PATCH 2/2] Corrected note --- pandas/core/generic.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pandas/core/generic.py b/pandas/core/generic.py index 6a066bfee3729..e0e9048b20a9d 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -772,8 +772,8 @@ def swapaxes(self, axis1: Axis, axis2: Axis, copy: bool_t | None = None) -> Self Interchange axes and swap values axes appropriately. .. deprecated:: 2.1.0 - ``swapaxes`` will be deprecated. - Please use ``transpose`` instead. + ``swapaxes`` is deprecated and will be removed. + Please use ``transpose`` instead. Returns -------