GH-41985: [Python][Docs] Clarify docstring of pyarrow.compute.scalar() #45668
Conversation
This file contains 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
|
@github-actions crossbow submit preview-docs |
|
Revision: 17fecc6 Submitted crossbow builds: ursacomputing/crossbow @ actions-86db13bc16
|
|
@jorisvandenbossche It seems that http://crossbow.voltrondata.com/pr_docs/45668/python/api/compute.html doesn't have |
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.
Rationale for this change
The current docstring for
pyarrow.compute.scalar()is incomplete and potentially misleading. It states that it only accepts "a subset of types" when in reality it accepts any value that can be converted to apyarrow.Scalar. Additionally, there's no clear explanation of the difference betweenpyarrow.scalar()andpyarrow.compute.scalar(), which can be confusing for users since both functions have the same name but serve different purposes.What changes are included in this PR?
This PR updates the docstring for
pyarrow.compute.scalar()to clarify that it accepts any value convertible to apyarrow.Scalarand add a detailed explanation of the difference betweenpyarrow.scalar()andpyarrow.compute.scalar()Are these changes tested?
via CI.
Are there any user-facing changes?
No.