Skip to content

Commit b50faa5

Browse files
jordan-d-murphypmhatre1
authored andcommitted
Doc: Fix PR07 errors for pandas.DataFrame.align (pandas-dev#57612)
Fix PR07 errors for pandas.DataFrame.align
1 parent ad06c66 commit b50faa5

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

ci/code_checks.sh

-2
Original file line numberDiff line numberDiff line change
@@ -724,7 +724,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
724724

725725
MSG='Partially validate docstrings (PR07)' ; echo $MSG
726726
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=PR07 --ignore_functions \
727-
pandas.DataFrame.align\
728727
pandas.DataFrame.get\
729728
pandas.DataFrame.rolling\
730729
pandas.DataFrame.to_hdf\
@@ -1127,7 +1126,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
11271126
pandas.CategoricalIndex.ordered\
11281127
pandas.DataFrame.__dataframe__\
11291128
pandas.DataFrame.__iter__\
1130-
pandas.DataFrame.align\
11311129
pandas.DataFrame.assign\
11321130
pandas.DataFrame.axes\
11331131
pandas.DataFrame.backfill\

pandas/core/generic.py

+6
Original file line numberDiff line numberDiff line change
@@ -9442,6 +9442,7 @@ def align(
94429442
Parameters
94439443
----------
94449444
other : DataFrame or Series
9445+
The object to align with.
94459446
join : {{'outer', 'inner', 'left', 'right'}}, default 'outer'
94469447
Type of alignment to be performed.
94479448
@@ -9482,6 +9483,11 @@ def align(
94829483
tuple of ({klass}, type of other)
94839484
Aligned objects.
94849485
9486+
See Also
9487+
--------
9488+
Series.align : Align two objects on their axes with specified join method.
9489+
DataFrame.align : Align two objects on their axes with specified join method.
9490+
94859491
Examples
94869492
--------
94879493
>>> df = pd.DataFrame(

0 commit comments

Comments
 (0)