From 22ea5891b42fc3b76f50b9e6e8322c5dd533711d Mon Sep 17 00:00:00 2001 From: Jonas Bergner Date: Fri, 8 Mar 2024 20:52:58 +0100 Subject: [PATCH 1/8] Add return info for nsmallest method --- pandas/core/frame.py | 1 + 1 file changed, 1 insertion(+) diff --git a/pandas/core/frame.py b/pandas/core/frame.py index 25501ff245e46..26eb6b38597f7 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -7432,6 +7432,7 @@ def nsmallest( Returns ------- DataFrame + DataFrame with the first `n` rows ordered by `columns` in ascending order. See Also -------- From 67f36d076f003dd4609ac2e85ae060757deb052f Mon Sep 17 00:00:00 2001 From: Jonas Bergner Date: Fri, 8 Mar 2024 21:26:27 +0100 Subject: [PATCH 2/8] Add result info on nunique. --- pandas/core/frame.py | 1 + 1 file changed, 1 insertion(+) diff --git a/pandas/core/frame.py b/pandas/core/frame.py index 26eb6b38597f7..88fa1148c0dfc 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -11899,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 -------- From 74d5cc1131c90f21bcb00f013933eac5523688fc Mon Sep 17 00:00:00 2001 From: Jonas Bergner Date: Fri, 8 Mar 2024 21:32:05 +0100 Subject: [PATCH 3/8] Add return information to pipe method. --- pandas/core/generic.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/pandas/core/generic.py b/pandas/core/generic.py index 5c8842162007d..1227f157a9fef 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -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 -------- @@ -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"]) From 8c4299800536130aff9ffba891da25ff086faa95 Mon Sep 17 00:00:00 2001 From: Jonas Bergner Date: Fri, 8 Mar 2024 21:45:02 +0100 Subject: [PATCH 4/8] Add return information for boxplot method --- pandas/plotting/_core.py | 1 + 1 file changed, 1 insertion(+) diff --git a/pandas/plotting/_core.py b/pandas/plotting/_core.py index edd619c264c7a..edcf57523f09b 100644 --- a/pandas/plotting/_core.py +++ b/pandas/plotting/_core.py @@ -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 -------- From 3a285c01bb25da361b494d5bc81f3a810696df1d Mon Sep 17 00:00:00 2001 From: Jonas Bergner Date: Fri, 8 Mar 2024 21:48:26 +0100 Subject: [PATCH 5/8] Add return information for kde plot. --- pandas/plotting/_core.py | 1 + 1 file changed, 1 insertion(+) diff --git a/pandas/plotting/_core.py b/pandas/plotting/_core.py index edcf57523f09b..74ba84fb70888 100644 --- a/pandas/plotting/_core.py +++ b/pandas/plotting/_core.py @@ -1467,6 +1467,7 @@ def kde( Returns ------- matplotlib.axes.Axes or numpy.ndarray of them + The matplotlib axes containing the KDE plot. See Also -------- From 916bce5a31df67ce6e10af930da3294a80187c08 Mon Sep 17 00:00:00 2001 From: Jonas Bergner Date: Fri, 8 Mar 2024 22:44:49 +0100 Subject: [PATCH 6/8] Add result information for scatter plot. --- pandas/plotting/_core.py | 1 + 1 file changed, 1 insertion(+) diff --git a/pandas/plotting/_core.py b/pandas/plotting/_core.py index 74ba84fb70888..c9d1e5a376bfd 100644 --- a/pandas/plotting/_core.py +++ b/pandas/plotting/_core.py @@ -1747,6 +1747,7 @@ def scatter( Returns ------- :class:`matplotlib.axes.Axes` or numpy.ndarray of them + The matplotlib axes containing the scatter plot. See Also -------- From 1758c117d8ea42d93b3b3c53d11bf5fc9f87980f Mon Sep 17 00:00:00 2001 From: Jonas Bergner Date: Fri, 8 Mar 2024 22:46:06 +0100 Subject: [PATCH 7/8] Remove resolved methods from ignore_functions parameter --- ci/code_checks.sh | 8 -------- 1 file changed, 8 deletions(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 1c37d9bf1c4b3..ada52d6a61f05 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -628,14 +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\ pandas.DataFrame.reindex\ From a0ea95588f7c4f4033c972a2d3f42b1d49bb9a1a Mon Sep 17 00:00:00 2001 From: Jonas Bergner Date: Fri, 8 Mar 2024 22:58:08 +0100 Subject: [PATCH 8/8] Reinsert method to code checker which was erroneously removed. --- ci/code_checks.sh | 1 + 1 file changed, 1 insertion(+) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index ada52d6a61f05..5437b4c66e300 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -628,6 +628,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then pandas.DataFrame.mean\ pandas.DataFrame.median\ pandas.DataFrame.min\ + pandas.DataFrame.pop\ pandas.DataFrame.prod\ pandas.DataFrame.product\ pandas.DataFrame.reindex\