Skip to content

Commit c150511

Browse files
DOC: Enforce Numpy Docstring Validation for pandas.DataFrame.__dataframe__ (#58491)
* DOC: add SA01 in pandas.DataFrame.__dataframe__ * DOC: remove SA01 in pandas.DataFrame.__dataframe__
1 parent 2e7fa91 commit c150511

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

ci/code_checks.sh

-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
7070
--format=actions \
7171
-i ES01 `# For now it is ok if docstrings are missing the extended summary` \
7272
-i "pandas.Series.dt PR01" `# Accessors are implemented as classes, but we do not document the Parameters section` \
73-
-i "pandas.DataFrame.__dataframe__ SA01" \
7473
-i "pandas.DataFrame.at_time PR01" \
7574
-i "pandas.DataFrame.kurt RT03,SA01" \
7675
-i "pandas.DataFrame.kurtosis RT03,SA01" \

pandas/core/frame.py

+5
Original file line numberDiff line numberDiff line change
@@ -931,6 +931,11 @@ def __dataframe__(
931931
DataFrame interchange object
932932
The object which consuming library can use to ingress the dataframe.
933933
934+
See Also
935+
--------
936+
DataFrame.from_records : Constructor from tuples, also record arrays.
937+
DataFrame.from_dict : From dicts of Series, arrays, or dicts.
938+
934939
Notes
935940
-----
936941
Details on the interchange protocol:

0 commit comments

Comments
 (0)