WIP: [Docs] Update extension type examples to not use UUID #43849

khwilson · 2024-08-27T14:07:39Z

Superseded by #44120

In a previous version of the docs, a UuidType was discussed as an extension type. However, this type has been promoted to a canonical type, and so no longer is a good example of an extension type a user may wish to create. We replace UuidType in the docs with a RationalType

github-actions · 2024-08-27T14:08:16Z

⚠️ GitHub issue #43809 has been automatically assigned in GitHub to PR creator.

ianmcook · 2024-08-27T20:44:14Z

@github-actions crossbow submit preview-docs

github-actions · 2024-08-27T20:46:28Z

Revision: fde3215

Submitted crossbow builds: ursacomputing/crossbow @ actions-d5e0428a8b

Task	Status
preview-docs

ianmcook · 2024-08-27T21:06:24Z

@khwilson I found one more docs page where there are a couple of mentions of UUID as an example of a user-defined extension type:

arrow/docs/source/format/Columnar.rst

Lines 1600 to 1604 in 75ca5b3

    
           extension type can still handle the underlying data. For example a 
        
           16-byte UUID value could be embedded in ``FixedSizeBinary(16)``, and 
        
           implementations that do not have this extension type can still work 
        
           with the underlying binary values and pass along the 
        
           ``custom_metadata`` in subsequent Arrow protocol messages.

arrow/docs/source/format/Columnar.rst

Line 1610 in 75ca5b3

* ``uuid`` represented as ``FixedSizeBinary(16)`` with empty metadata

Could you replace these with your rational example? Thanks

docs/source/python/extending_types.rst

python/pyarrow/types.pxi

docs/source/python/extending_types.rst

python/pyarrow/types.pxi

ianmcook · 2024-08-27T22:50:42Z

@khwilson thank you; this looks pretty good! I left a bunch of comments. They should be mostly be easy to address (except the bit about what "parameterized" means which might require some thinking about how best to explain it).

Co-authored-by: Ian Cook <[email protected]>

khwilson · 2024-09-14T17:52:21Z

Hi all. My deepest apologies. I got myself into a bit of trouble syncing with master and accidentally rebased instead of merging. I will close this issue for now to avoid spamming everyone as there is no way I know to unsubscribe you automatically.

ianmcook · 2024-09-14T18:45:18Z

No worries, it happens :) Tag me in the new PR and I will review

@ianmcook

### Rationale for this change UUID extension types were made canonical in #41299 and are getting native support in C++ and Python in #37298. As such, it makes sense to provide an alternative user-defined extension type as an example that is unlikely to become a canonical extension type anytime soon. After discussion in #43809, we determined a `RationalType` would make sense. Please note that this is a redo of #43849 as I made a blunder and accidentally pushed a branch that was in a wonky state. ### What changes are included in this PR? A change in several doc locations which reference a `UuidType` extension type have been changed to a `RationalType`. For consistency, this PR also changes single quotes (`''`) to double quotes (`""`) throughout the Python examples that it modifies. Also, seemingly unrelated to this change, some doctests began failing as numpy changed the `repr` of `float16`'s between 1.x and 2.x. We have updated the failing doctest so that it supports both styles. ### Are these changes tested? These are documentation changes and `archery docker run conda-python-docs` succeeds locally. ### Are there any user-facing changes? No. cc @ianmcook @rok * GitHub Issue: #43809 --------- Co-authored-by: Ian Cook <[email protected]>

khwilson added 3 commits August 27, 2024 13:42

fix json formatting

4d95f22

fix some typos

fde3215

github-actions bot added Component: Python Component: Documentation awaiting review Awaiting review labels Aug 27, 2024

ianmcook self-requested a review August 27, 2024 16:09