From 1d855bacca63347c71bb03b99b7bb06fbe5be82e Mon Sep 17 00:00:00 2001 From: Valery Lozko Date: Mon, 1 Apr 2024 09:49:56 -0400 Subject: [PATCH 1/2] Add 'See Also' section to pandas.DataFrame.axes for docstring validaton --- pandas/core/frame.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/pandas/core/frame.py b/pandas/core/frame.py index 50a93994dc76b..2915276d31f8c 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -993,6 +993,11 @@ def axes(self) -> list[Index]: It has the row axis labels and column axis labels as the only members. They are returned in that order. + + See Also + -------- + DataFrame.index: The index (row labels) of the DataFrame. + DataFrame.columns: The column labels of the DataFrame. Examples -------- From fcef65345be4bca8fabedfff91be3b17c9b8c1d4 Mon Sep 17 00:00:00 2001 From: Valery Lozko Date: Thu, 11 Apr 2024 08:17:51 -0400 Subject: [PATCH 2/2] Add 'See Also' section to pandas.DataFrame.axes for docstring validaton --- ci/code_checks.sh | 1 - pandas/core/frame.py | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 0c4e6641444f1..b2614b9355da0 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -83,7 +83,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then -i "pandas.DataFrame.__iter__ SA01" \ -i "pandas.DataFrame.assign SA01" \ -i "pandas.DataFrame.at_time PR01" \ - -i "pandas.DataFrame.axes SA01" \ -i "pandas.DataFrame.backfill PR01,SA01" \ -i "pandas.DataFrame.bfill SA01" \ -i "pandas.DataFrame.columns SA01" \ diff --git a/pandas/core/frame.py b/pandas/core/frame.py index 2915276d31f8c..a89ed5f499c5f 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -993,7 +993,7 @@ def axes(self) -> list[Index]: It has the row axis labels and column axis labels as the only members. They are returned in that order. - + See Also -------- DataFrame.index: The index (row labels) of the DataFrame.