Skip to content

DOC: Fix SA01 Docstring Errors for DataFrame #58364

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 4 commits into from
Apr 22, 2024
+15 −4
Merged

DOC: Fix SA01 Docstring Errors for DataFrame #58364

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
48a1c4b
DataFrame.__iter__ fix SA01
gboeker Apr 21, 2024
60a08da
add See Also for DataFrame.column
gboeker Apr 21, 2024
346697a
DataFrame.droplevel SA01 fixed
gboeker Apr 21, 2024
e3118fc
remove pandas.Series.droplevel from code_checks.sh
gboeker Apr 21, 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
4 changes: 0 additions & 4 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,10 +80,7 @@ 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" \
-i "pandas.DataFrame.hist RT03" \
-i "pandas.DataFrame.infer_objects RT03" \
-i "pandas.DataFrame.kurt RT03,SA01" \
Expand Down Expand Up @@ -287,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" \
Expand Down
4 changes: 4 additions & 0 deletions pandas/core/frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]})
Expand Down
11 changes: 11 additions & 0 deletions pandas/core/generic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 = (
Expand Down Expand Up @@ -1862,6 +1868,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]})
Expand Down
Loading