Skip to content

Commit b110046

Browse files
junjunjunkjunjunjunk
authored
DOC: make return type documentation of series methods consistent #35409 (#36862)
1 parent 7d257c6 commit b110046

File tree

7 files changed

+63
-55
lines changed

7 files changed

+63
-55
lines changed

‎pandas/core/arrays/categorical.py

+13-10
Original file line numberDiff line numberDiff line change
@@ -723,8 +723,8 @@ def as_ordered(self, inplace=False):
723723
724724
Returns
725725
-------
726-
Categorical
727-
Ordered Categorical.
726+
Categorical or None
727+
Ordered Categorical or None if ``inplace=True``.
728728
"""
729729
inplace = validate_bool_kwarg(inplace, "inplace")
730730
return self.set_ordered(True, inplace=inplace)
@@ -741,8 +741,8 @@ def as_unordered(self, inplace=False):
741741
742742
Returns
743743
-------
744-
Categorical
745-
Unordered Categorical.
744+
Categorical or None
745+
Unordered Categorical or None if ``inplace=True``.
746746
"""
747747
inplace = validate_bool_kwarg(inplace, "inplace")
748748
return self.set_ordered(False, inplace=inplace)
@@ -848,8 +848,7 @@ def rename_categories(self, new_categories, inplace=False):
848848
Returns
849849
-------
850850
cat : Categorical or None
851-
With ``inplace=False``, the new categorical is returned.
852-
With ``inplace=True``, there is no return value.
851+
Categorical with removed categories or None if ``inplace=True``.
853852
854853
Raises
855854
------
@@ -917,7 +916,8 @@ def reorder_categories(self, new_categories, ordered=None, inplace=False):
917916
918917
Returns
919918
-------
920-
cat : Categorical with reordered categories or None if inplace.
919+
cat : Categorical or None
920+
Categorical with removed categories or None if ``inplace=True``.
921921
922922
Raises
923923
------
@@ -957,7 +957,8 @@ def add_categories(self, new_categories, inplace=False):
957957
958958
Returns
959959
-------
960-
cat : Categorical with new categories added or None if inplace.
960+
cat : Categorical or None
961+
Categorical with new categories added or None if ``inplace=True``.
961962
962963
Raises
963964
------
@@ -1007,7 +1008,8 @@ def remove_categories(self, removals, inplace=False):
10071008
10081009
Returns
10091010
-------
1010-
cat : Categorical with removed categories or None if inplace.
1011+
cat : Categorical or None
1012+
Categorical with removed categories or None if ``inplace=True``.
10111013
10121014
Raises
10131015
------
@@ -1054,7 +1056,8 @@ def remove_unused_categories(self, inplace=False):
10541056
10551057
Returns
10561058
-------
1057-
cat : Categorical with unused categories dropped or None if inplace.
1059+
cat : Categorical or None
1060+
Categorical with unused categories dropped or None if ``inplace=True``.
10581061
10591062
See Also
10601063
--------

‎pandas/core/computation/eval.py

+2-1
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,8 @@ def eval(
242242
243243
Returns
244244
-------
245-
ndarray, numeric scalar, DataFrame, Series
245+
ndarray, numeric scalar, DataFrame, Series, or None
246+
The completion value of evaluating the given code or None if ``inplace=True``.
246247
247248
Raises
248249
------

‎pandas/core/frame.py

+17-15
Original file line numberDiff line numberDiff line change
@@ -3256,8 +3256,9 @@ def query(self, expr, inplace=False, **kwargs):
32563256
32573257
Returns
32583258
-------
3259-
DataFrame
3260-
DataFrame resulting from the provided query expression.
3259+
DataFrame or None
3260+
DataFrame resulting from the provided query expression or
3261+
None if ``inplace=True``.
32613262
32623263
See Also
32633264
--------
@@ -3404,8 +3405,8 @@ def eval(self, expr, inplace=False, **kwargs):
34043405
34053406
Returns
34063407
-------
3407-
ndarray, scalar, or pandas object
3408-
The result of the evaluation.
3408+
ndarray, scalar, pandas object, or None
3409+
The result of the evaluation or None if ``inplace=True``.
34093410
34103411
See Also
34113412
--------
@@ -4122,8 +4123,9 @@ def drop(
41224123
41234124
Returns
41244125
-------
4125-
DataFrame
4126-
DataFrame without the removed index or column labels.
4126+
DataFrame or None
4127+
DataFrame without the removed index or column labels or
4128+
None if ``inplace=True``.
41274129
41284130
Raises
41294131
------
@@ -4277,8 +4279,8 @@ def rename(
42774279
42784280
Returns
42794281
-------
4280-
DataFrame
4281-
DataFrame with the renamed axis labels.
4282+
DataFrame or None
4283+
DataFrame with the renamed axis labels or None if ``inplace=True``.
42824284
42834285
Raises
42844286
------
@@ -4533,8 +4535,8 @@ def set_index(
45334535
45344536
Returns
45354537
-------
4536-
DataFrame
4537-
Changed row labels.
4538+
DataFrame or None
4539+
Changed row labels or None if ``inplace=True``.
45384540
45394541
See Also
45404542
--------
@@ -4996,8 +4998,8 @@ def dropna(self, axis=0, how="any", thresh=None, subset=None, inplace=False):
49964998
49974999
Returns
49985000
-------
4999-
DataFrame
5000-
DataFrame with NA entries dropped from it.
5001+
DataFrame or None
5002+
DataFrame with NA entries dropped from it or None if ``inplace=True``.
50015003
50025004
See Also
50035005
--------
@@ -5132,7 +5134,7 @@ def drop_duplicates(
51325134
51335135
Returns
51345136
-------
5135-
DataFrame
5137+
DataFrame or None
51365138
DataFrame with duplicates removed or None if ``inplace=True``.
51375139
51385140
See Also
@@ -5455,8 +5457,8 @@ def sort_index(
54555457
54565458
Returns
54575459
-------
5458-
DataFrame
5459-
The original DataFrame sorted by the labels.
5460+
DataFrame or None
5461+
The original DataFrame sorted by the labels or None if ``inplace=True``.
54605462
54615463
See Also
54625464
--------

‎pandas/core/generic.py

+10-10
Original file line numberDiff line numberDiff line change
@@ -650,7 +650,7 @@ def set_axis(self, labels, axis: Axis = 0, inplace: bool = False):
650650
Returns
651651
-------
652652
renamed : %(klass)s or None
653-
An object of type %(klass)s if inplace=False, None otherwise.
653+
An object of type %(klass)s or None if ``inplace=True``.
654654
655655
See Also
656656
--------
@@ -1097,7 +1097,7 @@ def rename_axis(self, mapper=lib.no_default, **kwargs):
10971097
Returns
10981098
-------
10991099
Series, DataFrame, or None
1100-
The same type as the caller or None if `inplace` is True.
1100+
The same type as the caller or None if ``inplace=True``.
11011101
11021102
See Also
11031103
--------
@@ -4330,7 +4330,7 @@ def sort_values(
43304330
Returns
43314331
-------
43324332
DataFrame or None
4333-
DataFrame with sorted values if inplace=False, None otherwise.
4333+
DataFrame with sorted values or None if ``inplace=True``.
43344334
43354335
See Also
43364336
--------
@@ -6471,8 +6471,8 @@ def replace(
64716471
64726472
Returns
64736473
-------
6474-
{klass}
6475-
Object after replacement.
6474+
{klass} or None
6475+
Object after replacement or None if ``inplace=True``.
64766476
64776477
Raises
64786478
------
@@ -6907,9 +6907,9 @@ def interpolate(
69076907
69086908
Returns
69096909
-------
6910-
Series or DataFrame
6910+
Series or DataFrame or None
69116911
Returns the same object type as the caller, interpolated at
6912-
some or all ``NaN`` values.
6912+
some or all ``NaN`` values or None if ``inplace=True``.
69136913
69146914
See Also
69156915
--------
@@ -7508,9 +7508,9 @@ def clip(
75087508
75097509
Returns
75107510
-------
7511-
Series or DataFrame
7511+
Series or DataFrame or None
75127512
Same type as calling object with the values outside the
7513-
clip boundaries replaced.
7513+
clip boundaries replaced or None if ``inplace=True``.
75147514
75157515
See Also
75167516
--------
@@ -9064,7 +9064,7 @@ def where(
90649064
90659065
Returns
90669066
-------
9067-
Same type as caller
9067+
Same type as caller or None if ``inplace=True``.
90689068
90699069
See Also
90709070
--------

‎pandas/core/indexes/base.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -1319,8 +1319,8 @@ def set_names(self, names, level=None, inplace: bool = False):
13191319
13201320
Returns
13211321
-------
1322-
Index
1323-
The same type as the caller or None if inplace is True.
1322+
Index or None
1323+
The same type as the caller or None if ``inplace=True``.
13241324
13251325
See Also
13261326
--------
@@ -1395,8 +1395,8 @@ def rename(self, name, inplace=False):
13951395
13961396
Returns
13971397
-------
1398-
Index
1399-
The same type as the caller or None if inplace is True.
1398+
Index or None
1399+
The same type as the caller or None if ``inplace=True``.
14001400
14011401
See Also
14021402
--------

‎pandas/core/indexes/multi.py

+4-2
Original file line numberDiff line numberDiff line change
@@ -787,7 +787,8 @@ def set_levels(self, levels, level=None, inplace=None, verify_integrity=True):
787787
788788
Returns
789789
-------
790-
new index (of same type and class...etc)
790+
new index (of same type and class...etc) or None
791+
The same type as the caller or None if ``inplace=True``.
791792
792793
Examples
793794
--------
@@ -966,7 +967,8 @@ def set_codes(self, codes, level=None, inplace=None, verify_integrity=True):
966967
967968
Returns
968969
-------
969-
new index (of same type and class...etc)
970+
new index (of same type and class...etc) or None
971+
The same type as the caller or None if ``inplace=True``.
970972
971973
Examples
972974
--------

‎pandas/core/series.py

+13-13
Original file line numberDiff line numberDiff line change
@@ -1193,7 +1193,7 @@ def reset_index(self, level=None, drop=False, name=None, inplace=False):
11931193
11941194
Returns
11951195
-------
1196-
Series or DataFrame
1196+
Series or DataFrame or None
11971197
When `drop` is False (the default), a DataFrame is returned.
11981198
The newly created columns will come first in the DataFrame,
11991199
followed by the original Series values.
@@ -1917,8 +1917,8 @@ def drop_duplicates(self, keep="first", inplace=False) -> Optional["Series"]:
19171917
19181918
Returns
19191919
-------
1920-
Series
1921-
Series with duplicates dropped.
1920+
Series or None
1921+
Series with duplicates dropped or None if ``inplace=True``.
19221922
19231923
See Also
19241924
--------
@@ -3137,8 +3137,8 @@ def sort_values(
31373137
31383138
Returns
31393139
-------
3140-
Series
3141-
Series ordered by values.
3140+
Series or None
3141+
Series ordered by values or None if ``inplace=True``.
31423142
31433143
See Also
31443144
--------
@@ -3383,8 +3383,8 @@ def sort_index(
33833383
33843384
Returns
33853385
-------
3386-
Series
3387-
The original Series sorted by the labels.
3386+
Series or None
3387+
The original Series sorted by the labels or None if ``inplace=True``.
33883388
33893389
See Also
33903390
--------
@@ -4312,8 +4312,8 @@ def rename(
43124312
43134313
Returns
43144314
-------
4315-
Series
4316-
Series with index labels or name altered.
4315+
Series or None
4316+
Series with index labels or name altered or None if ``inplace=True``.
43174317
43184318
See Also
43194319
--------
@@ -4426,8 +4426,8 @@ def drop(
44264426
44274427
Returns
44284428
-------
4429-
Series
4430-
Series with specified index labels removed.
4429+
Series or None
4430+
Series with specified index labels removed or None if ``inplace=True``.
44314431
44324432
Raises
44334433
------
@@ -4815,8 +4815,8 @@ def dropna(self, axis=0, inplace=False, how=None):
48154815
48164816
Returns
48174817
-------
4818-
Series
4819-
Series with NA entries dropped from it.
4818+
Series or None
4819+
Series with NA entries dropped from it or None if ``inplace=True``.
48204820
48214821
See Also
48224822
--------

0 commit comments

Comments
 (0)