Skip to content
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

DOC: Resolve RT03 errors in several methods #2 #57785

Merged
merged 8 commits into from
Mar 8, 2024
Merged

DOC: Resolve RT03 errors in several methods #2 #57785

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
22ea589
Add return info for nsmallest method
Mar 8, 2024
67f36d0
Add result info on nunique.
Mar 8, 2024
74d5cc1
Add return information to pipe method.
Mar 8, 2024
8c42998
Add return information for boxplot method
Mar 8, 2024
3a285c0
Add return information for kde plot.
Mar 8, 2024
916bce5
Add result information for scatter plot.
Mar 8, 2024
1758c11
Remove resolved methods from ignore_functions parameter
Mar 8, 2024
a0ea955
Reinsert method to code checker which was erroneously removed.
Mar 8, 2024
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
7 changes: 0 additions & 7 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -628,13 +628,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
pandas.DataFrame.mean\
pandas.DataFrame.median\
pandas.DataFrame.min\
pandas.DataFrame.nsmallest\
pandas.DataFrame.nunique\
pandas.DataFrame.pipe\
pandas.DataFrame.plot.box\
pandas.DataFrame.plot.density\
pandas.DataFrame.plot.kde\
pandas.DataFrame.plot.scatter\
pandas.DataFrame.pop\
pandas.DataFrame.prod\
pandas.DataFrame.product\
Expand Down
2 changes: 2 additions & 0 deletions pandas/core/frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7432,6 +7432,7 @@ def nsmallest(
Returns
-------
DataFrame
DataFrame with the first `n` rows ordered by `columns` in ascending order.

See Also
--------
Expand Down Expand Up @@ -11898,6 +11899,7 @@ def nunique(self, axis: Axis = 0, dropna: bool = True) -> Series:
Returns
-------
Series
Series with counts of unique values per row or column, depending on `axis`.

See Also
--------
Expand Down
5 changes: 3 additions & 2 deletions pandas/core/generic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5839,7 +5839,8 @@ def pipe(

Returns
-------
the return type of ``func``.
The return type of ``func``.
The result of applying ``func`` to the Series or DataFrame.

See Also
--------
Expand All @@ -5855,7 +5856,7 @@ def pipe(

Examples
--------
Constructing a income DataFrame from a dictionary.
Constructing an income DataFrame from a dictionary.

>>> data = [[8000, 1000], [9500, np.nan], [5000, 2000]]
>>> df = pd.DataFrame(data, columns=["Salary", "Others"])
Expand Down
3 changes: 3 additions & 0 deletions pandas/plotting/_core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1335,6 +1335,7 @@ def box(self, by: IndexLabel | None = None, **kwargs) -> PlotAccessor:
Returns
-------
:class:`matplotlib.axes.Axes` or numpy.ndarray of them
The matplotlib axes containing the box plot.

See Also
--------
Expand Down Expand Up @@ -1466,6 +1467,7 @@ def kde(
Returns
-------
matplotlib.axes.Axes or numpy.ndarray of them
The matplotlib axes containing the KDE plot.

See Also
--------
Expand Down Expand Up @@ -1745,6 +1747,7 @@ def scatter(
Returns
-------
:class:`matplotlib.axes.Axes` or numpy.ndarray of them
The matplotlib axes containing the scatter plot.

See Also
--------
Expand Down