Skip to content

DOC: Fix SA01 for pandas.SparseDtype #58688

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 2 commits into from
May 12, 2024
+9 −2
Merged

DOC: Fix SA01 for pandas.SparseDtype #58688

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4f91c61
DOC: add SA01 for pandas.SparseDtype
tuhinsharma121 May 12, 2024
ab07975
DOC: remove SA01 for pandas.SparseDtype
tuhinsharma121 May 12, 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
1 change: 0 additions & 1 deletion ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Series.truediv PR07" \
-i "pandas.Series.update PR07,SA01" \
-i "pandas.Series.var PR01,RT03,SA01" \
-i "pandas.SparseDtype SA01" \
-i "pandas.Timedelta PR07,SA01" \
-i "pandas.Timedelta.as_unit SA01" \
-i "pandas.Timedelta.asm8 SA01" \
Expand Down
10 changes: 9 additions & 1 deletion pandas/core/dtypes/dtypes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1665,7 +1665,10 @@ class SparseDtype(ExtensionDtype):
"""
Dtype for data stored in :class:`SparseArray`.

This dtype implements the pandas ExtensionDtype interface.
`SparseDtype` is used as the data type for :class:`SparseArray`, enabling
more efficient storage of data that contains a significant number of
repetitive values typically represented by a fill value. It supports any
scalar dtype as the underlying data type of the non-fill values.

Parameters
----------
Expand Down Expand Up @@ -1695,6 +1698,11 @@ class SparseDtype(ExtensionDtype):
-------
None

See Also
--------
arrays.SparseArray : The array structure that uses SparseDtype
for data representation.

Examples
--------
>>> ser = pd.Series([1, 0, 0], dtype=pd.SparseDtype(dtype=int, fill_value=0))
Expand Down
Loading