Skip to content

Commit b479d1b

Browse files
bergnerjonaspmhatre1
authored andcommitted
DOC: Resolve RT03 errors in several methods pandas-dev#2 (pandas-dev#57785)
* Add return info for nsmallest method * Add result info on nunique. * Add return information to pipe method. * Add return information for boxplot method * Add return information for kde plot. * Add result information for scatter plot. * Remove resolved methods from ignore_functions parameter * Reinsert method to code checker which was erroneously removed.
1 parent d267989 commit b479d1b

File tree

4 files changed

+8
-9
lines changed

4 files changed

+8
-9
lines changed

ci/code_checks.sh

-7
Original file line numberDiff line numberDiff line change
@@ -623,13 +623,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
623623
pandas.DataFrame.mean\
624624
pandas.DataFrame.median\
625625
pandas.DataFrame.min\
626-
pandas.DataFrame.nsmallest\
627-
pandas.DataFrame.nunique\
628-
pandas.DataFrame.pipe\
629-
pandas.DataFrame.plot.box\
630-
pandas.DataFrame.plot.density\
631-
pandas.DataFrame.plot.kde\
632-
pandas.DataFrame.plot.scatter\
633626
pandas.DataFrame.pop\
634627
pandas.DataFrame.prod\
635628
pandas.DataFrame.product\

pandas/core/frame.py

+2
Original file line numberDiff line numberDiff line change
@@ -7432,6 +7432,7 @@ def nsmallest(
74327432
Returns
74337433
-------
74347434
DataFrame
7435+
DataFrame with the first `n` rows ordered by `columns` in ascending order.
74357436
74367437
See Also
74377438
--------
@@ -11898,6 +11899,7 @@ def nunique(self, axis: Axis = 0, dropna: bool = True) -> Series:
1189811899
Returns
1189911900
-------
1190011901
Series
11902+
Series with counts of unique values per row or column, depending on `axis`.
1190111903
1190211904
See Also
1190311905
--------

pandas/core/generic.py

+3-2
Original file line numberDiff line numberDiff line change
@@ -5846,7 +5846,8 @@ def pipe(
58465846
58475847
Returns
58485848
-------
5849-
the return type of ``func``.
5849+
The return type of ``func``.
5850+
The result of applying ``func`` to the Series or DataFrame.
58505851
58515852
See Also
58525853
--------
@@ -5862,7 +5863,7 @@ def pipe(
58625863
58635864
Examples
58645865
--------
5865-
Constructing a income DataFrame from a dictionary.
5866+
Constructing an income DataFrame from a dictionary.
58665867
58675868
>>> data = [[8000, 1000], [9500, np.nan], [5000, 2000]]
58685869
>>> df = pd.DataFrame(data, columns=["Salary", "Others"])

pandas/plotting/_core.py

+3
Original file line numberDiff line numberDiff line change
@@ -1335,6 +1335,7 @@ def box(self, by: IndexLabel | None = None, **kwargs) -> PlotAccessor:
13351335
Returns
13361336
-------
13371337
:class:`matplotlib.axes.Axes` or numpy.ndarray of them
1338+
The matplotlib axes containing the box plot.
13381339
13391340
See Also
13401341
--------
@@ -1466,6 +1467,7 @@ def kde(
14661467
Returns
14671468
-------
14681469
matplotlib.axes.Axes or numpy.ndarray of them
1470+
The matplotlib axes containing the KDE plot.
14691471
14701472
See Also
14711473
--------
@@ -1745,6 +1747,7 @@ def scatter(
17451747
Returns
17461748
-------
17471749
:class:`matplotlib.axes.Axes` or numpy.ndarray of them
1750+
The matplotlib axes containing the scatter plot.
17481751
17491752
See Also
17501753
--------

0 commit comments

Comments
 (0)