Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: add SA01 for pandas.api.extensions.ExtensionArray.shape #58705

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion ci/code_checks.sh
Original file line number Diff line number Diff line change
Expand Up @@ -337,7 +337,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.api.extensions.ExtensionArray.nbytes SA01" \
-i "pandas.api.extensions.ExtensionArray.ndim SA01" \
-i "pandas.api.extensions.ExtensionArray.ravel RT03,SA01" \
-i "pandas.api.extensions.ExtensionArray.shape SA01" \
-i "pandas.api.extensions.ExtensionArray.shift SA01" \
-i "pandas.api.extensions.ExtensionArray.take RT03" \
-i "pandas.api.extensions.ExtensionArray.tolist RT03,SA01" \
Expand Down
7 changes: 7 additions & 0 deletions pandas/core/arrays/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -610,6 +610,13 @@ def shape(self) -> Shape:
"""
Return a tuple of the array dimensions.

See Also
--------
numpy.ndarray.shape : Similar attribute which returns the shape of an array.
DataFrame.shape : Return a tuple representing the dimensionality of the
DataFrame.
Series.shape : Return a tuple representing the dimensionality of the Series.

Examples
--------
>>> arr = pd.array([1, 2, 3])
Expand Down
Loading