From f16c24439528d718ada480dfee85dfc5d6700bd3 Mon Sep 17 00:00:00 2001 From: kirwa Date: Wed, 12 Nov 2025 09:52:56 +0300 Subject: [PATCH] DOC: Enhance DataFrame.rename examples in docstring --- pandas/core/frame.py | 31 +++++++++++++++++++++++++------ 1 file changed, 25 insertions(+), 6 deletions(-) diff --git a/pandas/core/frame.py b/pandas/core/frame.py index ab667d92b7e04..9e0945c630e16 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -5985,12 +5985,31 @@ def rename( 1 2 5 2 3 6 - >>> df.rename({1: 2, 2: 4}, axis="index") - A B - 0 1 4 - 2 2 5 - 4 3 6 - """ + >>> df.rename({1: 2, 2: 4}, axis="index") + A B + 0 1 4 + 2 2 5 + 4 3 6 + + **Additional practical example showing index and columns rename:** + + >>> df = pd.DataFrame({"X": [1, 2, 3], "Y": [4, 5, 6]}, index=["a", "b", "c"]) + >>> df.rename(columns={"X": "new_X", "Y": "new_Y"}, + ... index={"a": "row1", "b": "row2", "c": "row3"}) + new_X new_Y + row1 1 4 + row2 2 5 + row3 3 6 + + **Using a function to transform column names:** + + >>> df = pd.DataFrame({"X": [1, 2, 3], "Y": [4, 5, 6]}, index=["a", "b", "c"]) + >>> df.rename(columns=str.lower, index=lambda x: x.upper()) + x y + A 1 4 + B 2 5 + C 3 6 + """ self._check_copy_deprecation(copy) return super()._rename( mapper=mapper,