Skip to content

Commit 706e642

Browse files
DOC: Fix SA04 errors in docstrings xref #28792 (#32180)
1 parent 283f81c commit 706e642

File tree

3 files changed

+19
-15
lines changed

3 files changed

+19
-15
lines changed

pandas/core/algorithms.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -313,8 +313,8 @@ def unique(values):
313313
314314
See Also
315315
--------
316-
Index.unique
317-
Series.unique
316+
Index.unique : Return unique values from an Index.
317+
Series.unique : Return unique values of Series object.
318318
319319
Examples
320320
--------
@@ -1515,7 +1515,7 @@ def take(arr, indices, axis: int = 0, allow_fill: bool = False, fill_value=None)
15151515
15161516
See Also
15171517
--------
1518-
numpy.take
1518+
numpy.take : Take elements from an array along an axis.
15191519
15201520
Examples
15211521
--------

pandas/core/frame.py

+9-8
Original file line numberDiff line numberDiff line change
@@ -358,9 +358,9 @@ class DataFrame(NDFrame):
358358
--------
359359
DataFrame.from_records : Constructor from tuples, also record arrays.
360360
DataFrame.from_dict : From dicts of Series, arrays, or dicts.
361-
read_csv
362-
read_table
363-
read_clipboard
361+
read_csv : Read a comma-separated values (csv) file into DataFrame.
362+
read_table : Read general delimited file into DataFrame.
363+
read_clipboard : Read text from clipboard into DataFrame.
364364
365365
Examples
366366
--------
@@ -7393,8 +7393,9 @@ def corr(self, method="pearson", min_periods=1) -> "DataFrame":
73937393
73947394
See Also
73957395
--------
7396-
DataFrame.corrwith
7397-
Series.corr
7396+
DataFrame.corrwith : Compute pairwise correlation with another
7397+
DataFrame or Series.
7398+
Series.corr : Compute the correlation between two Series.
73987399
73997400
Examples
74007401
--------
@@ -7596,7 +7597,7 @@ def corrwith(self, other, axis=0, drop=False, method="pearson") -> Series:
75967597
75977598
See Also
75987599
--------
7599-
DataFrame.corr
7600+
DataFrame.corr : Compute pairwise correlation of columns.
76007601
"""
76017602
axis = self._get_axis_number(axis)
76027603
this = self._get_numeric_data()
@@ -8001,7 +8002,7 @@ def idxmin(self, axis=0, skipna=True) -> Series:
80018002
80028003
See Also
80038004
--------
8004-
Series.idxmin
8005+
Series.idxmin : Return index of the minimum element.
80058006
80068007
Notes
80078008
-----
@@ -8039,7 +8040,7 @@ def idxmax(self, axis=0, skipna=True) -> Series:
80398040
80408041
See Also
80418042
--------
8042-
Series.idxmax
8043+
Series.idxmax : Return index of the maximum element.
80438044
80448045
Notes
80458046
-----

pandas/core/series.py

+7-4
Original file line numberDiff line numberDiff line change
@@ -555,7 +555,7 @@ def ravel(self, order="C"):
555555
556556
See Also
557557
--------
558-
numpy.ndarray.ravel
558+
numpy.ndarray.ravel : Return a flattened array.
559559
"""
560560
return self._values.ravel(order=order)
561561

@@ -2079,6 +2079,9 @@ def round(self, decimals=0, *args, **kwargs) -> "Series":
20792079
decimals : int, default 0
20802080
Number of decimal places to round to. If decimals is negative,
20812081
it specifies the number of positions to the left of the decimal point.
2082+
*args, **kwargs
2083+
Additional arguments and keywords have no effect but might be
2084+
accepted for compatibility with NumPy.
20822085
20832086
Returns
20842087
-------
@@ -2133,8 +2136,8 @@ def quantile(self, q=0.5, interpolation="linear"):
21332136
21342137
See Also
21352138
--------
2136-
core.window.Rolling.quantile
2137-
numpy.percentile
2139+
core.window.Rolling.quantile : Calculate the rolling quantile.
2140+
numpy.percentile : Returns the q-th percentile(s) of the array elements.
21382141
21392142
Examples
21402143
--------
@@ -3152,7 +3155,7 @@ def argsort(self, axis=0, kind="quicksort", order=None) -> "Series":
31523155
31533156
See Also
31543157
--------
3155-
numpy.ndarray.argsort
3158+
numpy.ndarray.argsort : Returns the indices that would sort this array.
31563159
"""
31573160
values = self._values
31583161
mask = isna(values)

0 commit comments

Comments
 (0)