From ee95eea37211e0dccb7468d58b4d4273545bf43f Mon Sep 17 00:00:00 2001 From: Tuhin Sharma Date: Tue, 30 Apr 2024 17:45:23 +0530 Subject: [PATCH 1/2] DOC: add SA01 in pandas.DataFrame.__dataframe__ --- pandas/core/frame.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/pandas/core/frame.py b/pandas/core/frame.py index 9fbbc2c08efaa..b7eba737829ec 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -931,6 +931,11 @@ def __dataframe__( DataFrame interchange object The object which consuming library can use to ingress the dataframe. + See Also + -------- + DataFrame.from_records : Constructor from tuples, also record arrays. + DataFrame.from_dict : From dicts of Series, arrays, or dicts. + Notes ----- Details on the interchange protocol: From 2dfb0fbe0e78083f05e63e1326ccee7a507211c9 Mon Sep 17 00:00:00 2001 From: Tuhin Sharma Date: Tue, 30 Apr 2024 17:45:48 +0530 Subject: [PATCH 2/2] DOC: remove SA01 in pandas.DataFrame.__dataframe__ --- ci/code_checks.sh | 1 - 1 file changed, 1 deletion(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 161047197ff6f..a059c91a92aa8 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -70,7 +70,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then --format=actions \ -i ES01 `# For now it is ok if docstrings are missing the extended summary` \ -i "pandas.Series.dt PR01" `# Accessors are implemented as classes, but we do not document the Parameters section` \ - -i "pandas.DataFrame.__dataframe__ SA01" \ -i "pandas.DataFrame.at_time PR01" \ -i "pandas.DataFrame.kurt RT03,SA01" \ -i "pandas.DataFrame.kurtosis RT03,SA01" \