Skip to content

DOC: Enforce Numpy Docstring Validation for pandas.Int #58511

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
May 1, 2024
Merged

DOC: Enforce Numpy Docstring Validation for pandas.Int #58511

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9de0a18
DOC: add SA01 for Int16Dtype,Int32Dtype,Int64Dtype,Int8Dtype
tuhinsharma121 May 1, 2024
482146b
DOC: remove SA01 for Int16Dtype,Int32Dtype,Int64Dtype,Int8Dtype
tuhinsharma121 May 1, 2024
27efe8c
DOC: remove SA01 for Int16Dtype,Int32Dtype,Int64Dtype,Int8Dtype
tuhinsharma121 May 1, 2024
0907f2e
Merge remote-tracking branch 'upstream/main' into numpy-docstring-int
tuhinsharma121 May 1, 2024
62ffc33
DOC: change description to n-bit nullable integer type
tuhinsharma121 May 1, 2024
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
8 changes: 0 additions & 8 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,10 +90,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Index.names GL08" \
-i "pandas.Index.ravel PR01,RT03" \
-i "pandas.Index.str PR01,SA01" \
-i "pandas.Int16Dtype SA01" \
-i "pandas.Int32Dtype SA01" \
-i "pandas.Int64Dtype SA01" \
-i "pandas.Int8Dtype SA01" \
-i "pandas.Interval PR02" \
-i "pandas.Interval.closed SA01" \
-i "pandas.Interval.left SA01" \
Expand Down Expand Up @@ -393,10 +389,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Timestamp.weekday SA01" \
-i "pandas.Timestamp.weekofyear SA01" \
-i "pandas.Timestamp.year GL08" \
-i "pandas.UInt16Dtype SA01" \
-i "pandas.UInt32Dtype SA01" \
-i "pandas.UInt64Dtype SA01" \
-i "pandas.UInt8Dtype SA01" \
-i "pandas.api.extensions.ExtensionArray SA01" \
-i "pandas.api.extensions.ExtensionArray._accumulate RT03,SA01" \
-i "pandas.api.extensions.ExtensionArray._concat_same_type PR07,SA01" \
Expand Down
7 changes: 7 additions & 0 deletions pandas/core/arrays/integer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,13 @@ class IntegerArray(NumericArray):
-------
None

See Also
--------
Int8Dtype : 8-bit nullable integer type.
Int16Dtype : 16-bit nullable integer type.
Int32Dtype : 32-bit nullable integer type.
Int64Dtype : 64-bit nullable integer type.

Examples
--------
For Int8Dtype:
Expand Down