Skip to content

DOC: Fix SA04 errors in docstrings xref #28792 #32180

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Mar 3, 2020
Merged

DOC: Fix SA04 errors in docstrings xref #28792 #32180

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
32097bc
DOC: Fix SA04 errors in doc. Fixed line too long error
AdrianMastronardi Feb 22, 2020
1578585
DOC: fixing a duplicated double-colon typo
AdrianMastronardi Feb 22, 2020
88697a4
Update pandas/core/algorithms.py
AdrianMastronardi Feb 28, 2020
a0bfd97
DOC: Fix SA04 errors in docstrings xref #28792 following @datapythoni…
AdrianMastronardi Feb 28, 2020
0259d16
Merge branch 'doc-contrib_28792_1' of https://github.com/AdrianMastro…
AdrianMastronardi Feb 28, 2020
7433adf
Update pandas/core/frame.py
AdrianMastronardi Feb 28, 2020
8f36a44
Update pandas/core/frame.py
AdrianMastronardi Feb 28, 2020
cdbd3cd
Incorporating changes suggested by @simonjayhawkins
AdrianMastronardi Feb 28, 2020
4b2ac5e
Merge remote-tracking branch 'upstream/master' into doc-contrib_28792_1
AdrianMastronardi Feb 28, 2020
42d6097
Incorporating changes suggested by @simonjayhawkins
AdrianMastronardi Feb 28, 2020
9ab2c5a
Update pandas/core/frame.py
AdrianMastronardi Mar 3, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions pandas/core/algorithms.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,8 +313,8 @@ def unique(values):

See Also
--------
Index.unique
Series.unique
Index.unique : Return Index with unique values from an Index object.
Series.unique : Return unique values of Series object.

Examples
--------
Expand Down Expand Up @@ -1515,7 +1515,7 @@ def take(arr, indices, axis: int = 0, allow_fill: bool = False, fill_value=None)

See Also
--------
numpy.take
numpy.take : Take elements from an array along an axis.

Examples
--------
Expand Down
19 changes: 11 additions & 8 deletions pandas/core/frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -358,9 +358,9 @@ class DataFrame(NDFrame):
--------
DataFrame.from_records : Constructor from tuples, also record arrays.
DataFrame.from_dict : From dicts of Series, arrays, or dicts.
read_csv
read_table
read_clipboard
read_csv : Read a comma-separated values (csv) file into DataFrame.
read_table : Read general delimited file into DataFrame.
read_clipboard : Read text from clipboard and pass to read_table.

Examples
--------
Expand Down Expand Up @@ -7292,8 +7292,9 @@ def corr(self, method="pearson", min_periods=1) -> "DataFrame":

See Also
--------
DataFrame.corrwith
Series.corr
DataFrame.corrwith : Compute pairwise correlation between rows or
columns of two DataFrame objects.
Series.corr : Compute the correlation between two Series.

Examples
--------
Expand Down Expand Up @@ -7495,7 +7496,7 @@ def corrwith(self, other, axis=0, drop=False, method="pearson") -> Series:

See Also
--------
DataFrame.corr
DataFrame.corr : Compute pairwise correlation of columns.
"""
axis = self._get_axis_number(axis)
this = self._get_numeric_data()
Expand Down Expand Up @@ -7900,7 +7901,8 @@ def idxmin(self, axis=0, skipna=True) -> Series:

See Also
--------
Series.idxmin
Series.idxmin : Return index *label* of the first occurrence
of minimum of values.

Notes
-----
Expand Down Expand Up @@ -7938,7 +7940,8 @@ def idxmax(self, axis=0, skipna=True) -> Series:

See Also
--------
Series.idxmax
Series.idxmax : Return index *label* of the first occurrence
of maximum of values.

Notes
-----
Expand Down
11 changes: 7 additions & 4 deletions pandas/core/series.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -552,7 +552,7 @@ def ravel(self, order="C"):

See Also
--------
numpy.ndarray.ravel
numpy.ndarray.ravel : Return a flattened array.
"""
return self._values.ravel(order=order)

Expand Down Expand Up @@ -2074,6 +2074,9 @@ def round(self, decimals=0, *args, **kwargs) -> "Series":
decimals : int, default 0
Number of decimal places to round to. If decimals is negative,
it specifies the number of positions to the left of the decimal point.
*args, **kwargs
Additional arguments and keywords have no effect but might be
accepted for compatibility with NumPy.

Returns
-------
Expand Down Expand Up @@ -2128,8 +2131,8 @@ def quantile(self, q=0.5, interpolation="linear"):

See Also
--------
core.window.Rolling.quantile
numpy.percentile
core.window.Rolling.quantile : Calculate the %(name)s quantile.
numpy.percentile : Returns the q-th percentile(s) of the array elements.

Examples
--------
Expand Down Expand Up @@ -3147,7 +3150,7 @@ def argsort(self, axis=0, kind="quicksort", order=None) -> "Series":

See Also
--------
numpy.ndarray.argsort
numpy.ndarray.argsort : Returns the indices that would sort this array.
"""
values = self._values
mask = isna(values)
Expand Down