-
-
Notifications
You must be signed in to change notification settings - Fork 18.8k
DOC: updated BooleanDType docstring #62045
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
Open
saguaro1234
wants to merge
4
commits into
pandas-dev:main
Choose a base branch
from
saguaro1234:boolean-docstring
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+21
−3
Open
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -41,11 +41,16 @@ | |
@register_extension_dtype | ||
class BooleanDtype(BaseMaskedDtype): | ||
""" | ||
Extension dtype for boolean data. | ||
Extend Boolean data type. | ||
|
||
`BooleanDtype` enables use of null boolean data in pandas structures such as | ||
`Series` and `array`. Internally, it is backed by pandas BooleanArray, | ||
which stores data using two numpy boolean arrays: one to store values | ||
('True'/'False') and a mask to indicate missing values (`pd.NA`) | ||
|
||
.. warning:: | ||
|
||
BooleanDtype is considered experimental. The implementation and | ||
BooleanArray is considered experimental. The implementation and | ||
parts of the API may change without warning. | ||
|
||
Attributes | ||
|
@@ -54,14 +59,27 @@ class BooleanDtype(BaseMaskedDtype): | |
|
||
Methods | ||
------- | ||
None | ||
__from_arrow__(array) | ||
Construct BooleanArray from pyarrow Array/ChunkedArray. | ||
|
||
See Also | ||
-------- | ||
StringDtype : Extension dtype for string data. | ||
BooleanArray: Array of boolean (True/False) data with missing values. | ||
BaseMaskedDType: Base class for dtypes for the BaseMaskedArray subclasses. | ||
|
||
Examples | ||
-------- | ||
Creating a Boolean series with missing values: | ||
|
||
>>> pd.Series([True, False, pd.NA], dtype="boolean") | ||
0 True | ||
1 False | ||
2 <NA> | ||
dtype: boolean | ||
|
||
Constructing a BooleanDType directly: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. same here |
||
|
||
>>> pd.BooleanDtype() | ||
BooleanDtype | ||
""" | ||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: it should be BaseMaskedDtype (type is lowercase)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, I will change that