Skip to content

Doc: Fix PR07 errors for pandas.DataFrame.align #57612

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 1 commit into from
Feb 26, 2024
+6 −2
Merged

Doc: Fix PR07 errors for pandas.DataFrame.align #57612

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 0 additions & 2 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1766,7 +1766,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then

MSG='Partially validate docstrings (PR07)' ; echo $MSG
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=PR07 --ignore_functions \
pandas.DataFrame.align\
pandas.DataFrame.get\
pandas.DataFrame.rolling\
pandas.DataFrame.to_hdf\
Expand Down Expand Up @@ -2170,7 +2169,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
pandas.CategoricalIndex.ordered\
pandas.DataFrame.__dataframe__\
pandas.DataFrame.__iter__\
pandas.DataFrame.align\
pandas.DataFrame.assign\
pandas.DataFrame.axes\
pandas.DataFrame.backfill\
Expand Down
6 changes: 6 additions & 0 deletions pandas/core/generic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9442,6 +9442,7 @@ def align(
Parameters
----------
other : DataFrame or Series
The object to align with.
join : {{'outer', 'inner', 'left', 'right'}}, default 'outer'
Type of alignment to be performed.

Expand Down Expand Up @@ -9482,6 +9483,11 @@ def align(
tuple of ({klass}, type of other)
Aligned objects.

See Also
--------
Series.align : Align two objects on their axes with specified join method.
DataFrame.align : Align two objects on their axes with specified join method.

Examples
--------
>>> df = pd.DataFrame(
Expand Down