DOC: Add pyarrow type equivalency table #50474
Merged
Conversation
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
doc/source/reference/arrays.rst
Outdated
| ===================================== ========================== =================== | ||
| Pyarrow type pandas extension type Numpy type | ||
| ===================================== ========================== =================== | ||
| ``pd.ArroeDtype(pa.bool_())`` :class:`BooleanDtype` ``np.bool_`` |
There was a problem hiding this comment.
Suggested change
| ``pd.ArroeDtype(pa.bool_())`` :class:`BooleanDtype` ``np.bool_`` | |
| ``pd.ArrowDtype(pa.bool_())`` :class:`BooleanDtype` ``np.bool_`` |
typo
doc/source/reference/arrays.rst
Outdated
| ===================================== ========================== =================== | ||
| Pyarrow type pandas extension type Numpy type | ||
| ===================================== ========================== =================== | ||
| ``pd.ArroeDtype(pa.bool_())`` :class:`BooleanDtype` ``np.bool_`` |
There was a problem hiding this comment.
Do you think repeating pd.ArrowDtype to wrap every arrow type in this column adds value? Since the column title is Pyarrow type, feels like just using pa.bool_()... is good enough. And maybe a note to comment on creating a pandas arrow type before or after the table could be useful.
There was a problem hiding this comment.
Fair point. I'll link to the pyarrow factory type functions and explain they need to be passed into pd.ArrowDtype explicitly
doc/source/reference/arrays.rst
Outdated
| The table below shows the equivalent pyarrow-backed (``pa``), pandas extension, and numpy (``np``) types that are recognized by pandas. | ||
|
|
||
| ===================================== ========================== =================== | ||
| Pyarrow type pandas extension type Numpy type |
There was a problem hiding this comment.
Suggested change
| Pyarrow type pandas extension type Numpy type | |
| PyArrow type pandas extension type NumPy type |
I think this is the preferred capitalization.
WillAyd
approved these changes
Dec 29, 2022
datapythonista
approved these changes
Jan 4, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.