-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
GH-43809: [Docs] Update extension type examples to not use UUID #44120
Conversation
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
Co-authored-by: Ian Cook <[email protected]>
Co-authored-by: Ian Cook <[email protected]>
Co-authored-by: Ian Cook <[email protected]>
Co-authored-by: Ian Cook <[email protected]>
@ianmcook, apologies again for accidentally pushing my wonky branch. The two remaining issues with the build were (1) some spacing issues arising from my IDE's formatter and copy/pasting outputs from terminals; and (b) Numpy changed the |
@github-actions crossbow submit preview-docs |
Revision: ff67035 Submitted crossbow builds: ursacomputing/crossbow @ actions-51ff65abfb
|
Co-authored-by: Ian Cook <[email protected]>
Co-authored-by: Ian Cook <[email protected]>
Co-authored-by: Ian Cook <[email protected]>
Co-authored-by: Ian Cook <[email protected]>
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.
Thanks @khwilson! This looks great. I will merge this soon unless @rok, @jorisvandenbossche, or others have any further comments.
@github-actions crossbow submit preview-docs |
Revision: 0502ff8 Submitted crossbow builds: ursacomputing/crossbow @ actions-8955adf366
|
Thanks again @khwilson! |
After merging your PR, Conbench analyzed the 4 benchmarking runs that have been run so far on merge-commit 0d4badb. There were no benchmark performance regressions. 🎉 The full Conbench report has more details. It also includes information about 4 possible false positives for unstable benchmarks that are known to sometimes produce them. |
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 aRationalType
.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
offloat16
'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