From 48a1c4ba400f5666106432495f951e09525dbd46 Mon Sep 17 00:00:00 2001 From: gboeker Date: Sun, 21 Apr 2024 18:40:41 -0400 Subject: [PATCH 1/4] DataFrame.__iter__ fix SA01 --- ci/code_checks.sh | 1 - pandas/core/generic.py | 5 +++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index cabc25b5e0ba5..53b9310c82cd0 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -80,7 +80,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then -i "pandas.CategoricalIndex.codes SA01" \ -i "pandas.CategoricalIndex.ordered SA01" \ -i "pandas.DataFrame.__dataframe__ SA01" \ - -i "pandas.DataFrame.__iter__ SA01" \ -i "pandas.DataFrame.at_time PR01" \ -i "pandas.DataFrame.columns SA01" \ -i "pandas.DataFrame.droplevel SA01" \ diff --git a/pandas/core/generic.py b/pandas/core/generic.py index dbe2006642484..9dcbcf50dfa19 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -1862,6 +1862,11 @@ def __iter__(self) -> Iterator: iterator Info axis as iterator. + See Also + -------- + DataFrame.items : Iterate over (column name, Series) pairs. + DataFrame.itertuples : Iterate over DataFrame rows as namedtuples. + Examples -------- >>> df = pd.DataFrame({"A": [1, 2, 3], "B": [4, 5, 6]}) From 60a08da0a8247a4404aac6b5fcf7fd8929d473cb Mon Sep 17 00:00:00 2001 From: gboeker Date: Sun, 21 Apr 2024 18:49:12 -0400 Subject: [PATCH 2/4] add See Also for DataFrame.column --- ci/code_checks.sh | 1 - pandas/core/frame.py | 4 ++++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 53b9310c82cd0..25dfcb4a6eddf 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -81,7 +81,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then -i "pandas.CategoricalIndex.ordered SA01" \ -i "pandas.DataFrame.__dataframe__ SA01" \ -i "pandas.DataFrame.at_time PR01" \ - -i "pandas.DataFrame.columns SA01" \ -i "pandas.DataFrame.droplevel SA01" \ -i "pandas.DataFrame.hist RT03" \ -i "pandas.DataFrame.infer_objects RT03" \ diff --git a/pandas/core/frame.py b/pandas/core/frame.py index 0185ca8241617..50dc514e7181f 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -12893,6 +12893,10 @@ def isin_(x): """ The column labels of the DataFrame. + See Also + -------- + DataFrame.index: The index (row labels) of the DataFrame. + Examples -------- >>> df = pd.DataFrame({'A': [1, 2], 'B': [3, 4]}) From 346697ae51c2c146de0c074dff7d7f12cbedc564 Mon Sep 17 00:00:00 2001 From: gboeker Date: Sun, 21 Apr 2024 18:52:52 -0400 Subject: [PATCH 3/4] DataFrame.droplevel SA01 fixed --- ci/code_checks.sh | 1 - pandas/core/generic.py | 6 ++++++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 25dfcb4a6eddf..7a678e872f6c3 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -81,7 +81,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then -i "pandas.CategoricalIndex.ordered SA01" \ -i "pandas.DataFrame.__dataframe__ SA01" \ -i "pandas.DataFrame.at_time PR01" \ - -i "pandas.DataFrame.droplevel SA01" \ -i "pandas.DataFrame.hist RT03" \ -i "pandas.DataFrame.infer_objects RT03" \ -i "pandas.DataFrame.kurt RT03,SA01" \ diff --git a/pandas/core/generic.py b/pandas/core/generic.py index 9dcbcf50dfa19..a7f155ec93524 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -783,6 +783,12 @@ def droplevel(self, level: IndexLabel, axis: Axis = 0) -> Self: {klass} {klass} with requested index / column level(s) removed. + See Also + -------- + DataFrame.replace : Replace values given in `to_replace` with `value`. + DataFrame.pivot : Return reshaped DataFrame organized by given + index / column values. + Examples -------- >>> df = ( From e3118fc3b78880c0ae3d4be05802c18998dd4523 Mon Sep 17 00:00:00 2001 From: gboeker Date: Sun, 21 Apr 2024 19:13:48 -0400 Subject: [PATCH 4/4] remove pandas.Series.droplevel from code_checks.sh --- ci/code_checks.sh | 1 - 1 file changed, 1 deletion(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 7a678e872f6c3..5802aa8418058 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -284,7 +284,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then -i "pandas.Series.cat.reorder_categories PR01,PR02" \ -i "pandas.Series.cat.set_categories PR01,PR02" \ -i "pandas.Series.div PR07" \ - -i "pandas.Series.droplevel SA01" \ -i "pandas.Series.dt.as_unit PR01,PR02" \ -i "pandas.Series.dt.ceil PR01,PR02,SA01" \ -i "pandas.Series.dt.components SA01" \