Skip to content

Commit af68e19

Browse files
Update docs and overload for Series.rename
1 parent ddcec67 commit af68e19

File tree

1 file changed

+4
-39
lines changed

1 file changed

+4
-39
lines changed

pandas/core/series.py

Lines changed: 4 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -4641,42 +4641,6 @@ def _needs_reindex_multi(self, axes, method, level) -> bool:
46414641
"""
46424642
return False
46434643

4644-
@overload
4645-
def rename(
4646-
self,
4647-
index: Renamer | Hashable | None = ...,
4648-
*,
4649-
axis: Axis | None = ...,
4650-
copy: bool | lib.NoDefault = ...,
4651-
inplace: Literal[True],
4652-
level: Level | None = ...,
4653-
errors: IgnoreRaise = ...,
4654-
) -> None: ...
4655-
4656-
@overload
4657-
def rename(
4658-
self,
4659-
index: Renamer | Hashable | None = ...,
4660-
*,
4661-
axis: Axis | None = ...,
4662-
copy: bool | lib.NoDefault = ...,
4663-
inplace: Literal[False] = ...,
4664-
level: Level | None = ...,
4665-
errors: IgnoreRaise = ...,
4666-
) -> Series: ...
4667-
4668-
@overload
4669-
def rename(
4670-
self,
4671-
index: Renamer | Hashable | None = ...,
4672-
*,
4673-
axis: Axis | None = ...,
4674-
copy: bool | lib.NoDefault = ...,
4675-
inplace: bool = ...,
4676-
level: Level | None = ...,
4677-
errors: IgnoreRaise = ...,
4678-
) -> Series | None: ...
4679-
46804644
def rename(
46814645
self,
46824646
index: Renamer | Hashable | None = None,
@@ -4686,7 +4650,7 @@ def rename(
46864650
inplace: bool = False,
46874651
level: Level | None = None,
46884652
errors: IgnoreRaise = "ignore",
4689-
) -> Series | None:
4653+
) -> Series:
46904654
"""
46914655
Alter Series index labels or name.
46924656
@@ -4734,8 +4698,9 @@ def rename(
47344698
47354699
Returns
47364700
-------
4737-
Series or None
4738-
Series with index labels or name altered or None if ``inplace=True``.
4701+
Series
4702+
Series with index labels or name altered as a copy or the same object
4703+
if ``inplace=True``.
47394704
47404705
See Also
47414706
--------

0 commit comments

Comments
 (0)