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.

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

GH-44711: [Docs][Python] Add missing canonical extension types to PyArrow arrays and datatypes docs #44880

Merged
merged 4 commits into from
Dec 9, 2024
Merged

GH-44711: [Docs][Python] Add missing canonical extension types to PyArrow arrays and datatypes docs #44880

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
172e98c
Add missing canonical extension types to PyArrow arrays and datatypes…
msebbah Nov 28, 2024
306df4f
Remove a needless change
kou Nov 29, 2024
73b5813
Reorder new entries
msebbah Nov 29, 2024
27f6d23
Add missing entries to PyArrow scalars docs
msebbah Dec 4, 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
10 changes: 10 additions & 0 deletions docs/source/python/api/arrays.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ may expose data type-specific methods or properties.
DurationArray
MonthDayNanoIntervalArray
Decimal128Array
Decimal256Array
DictionaryArray
ListArray
FixedSizeListArray
Expand All @@ -86,6 +87,9 @@ may expose data type-specific methods or properties.
ExtensionArray
FixedShapeTensorArray
OpaqueArray
JsonArray
UuidArray
Bool8Array

.. _api.scalar:

Expand All @@ -112,6 +116,7 @@ classes may expose data type-specific methods or properties.
Int16Scalar
Int32Scalar
Int64Scalar
NullScalar
UInt8Scalar
UInt16Scalar
UInt32Scalar
Expand All @@ -134,9 +139,11 @@ classes may expose data type-specific methods or properties.
DurationScalar
MonthDayNanoIntervalScalar
Decimal128Scalar
Decimal256Scalar
DictionaryScalar
RunEndEncodedScalar
ListScalar
FixedSizeListScalar
LargeListScalar
ListViewScalar
LargeListViewScalar
Expand All @@ -146,3 +153,6 @@ classes may expose data type-specific methods or properties.
ExtensionScalar
FixedShapeTensorScalar
OpaqueScalar
JsonScalar
UuidScalar
Bool8Scalar
17 changes: 17 additions & 0 deletions docs/source/python/api/datatypes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,13 @@ These should be used to create Arrow data types and schemas.
dictionary
run_end_encoded
fixed_shape_tensor
union
dense_union
sparse_union
opaque
bool8
uuid
json_
field
schema
from_numpy_dtype
Expand Down Expand Up @@ -96,13 +102,19 @@ functions above.
DataType
DictionaryType
ListType
ListViewType
FixedSizeListType
LargeListType
LargeListViewType
MapType
StructType
UnionType
DenseUnionType
SparseUnionType
TimestampType
Time32Type
Time64Type
DurationType
FixedSizeBinaryType
Decimal128Type
Decimal256Type
Expand All @@ -115,8 +127,10 @@ Specific classes and functions for extension types.
.. autosummary::
:toctree: ../generated/

BaseExtensionType
ExtensionType
PyExtensionType
UnknownExtensionType
register_extension_type
unregister_extension_type

Expand All @@ -128,6 +142,9 @@ implemented by PyArrow.

FixedShapeTensorType
OpaqueType
JsonType
UuidType
Bool8Type

.. _api.types.checking:
.. currentmodule:: pyarrow.types
Expand Down
Loading