From 2bd73597dd6d1d071f6ed1e05584b2e77757319f Mon Sep 17 00:00:00 2001 From: Jordan Murphy <35613487+jordan-d-murphy@users.noreply.github.com> Date: Sun, 25 Feb 2024 01:12:36 -0700 Subject: [PATCH] Fix PR07 errors for pandas.DataFrame.align --- ci/code_checks.sh | 2 -- pandas/core/generic.py | 6 ++++++ 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 47a2cf93a4f89..bbfe67e2ae94c 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -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\ @@ -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\ diff --git a/pandas/core/generic.py b/pandas/core/generic.py index 9424e421fd85f..866aae5bdd613 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -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. @@ -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(