[SPARK-46243][SQL][DOCS] Describe arguments of decode()#44157
Closed
MaxGekk wants to merge 2 commits intoapache:masterfrom
Closed
[SPARK-46243][SQL][DOCS] Describe arguments of decode()#44157MaxGekk wants to merge 2 commits intoapache:masterfrom
decode()#44157MaxGekk wants to merge 2 commits intoapache:masterfrom
Conversation
HyukjinKwon
approved these changes
Dec 4, 2023
MaxGekk
changed the title
decode()decode()
beliefer
reviewed
Dec 4, 2023
| arguments = """ | ||
| Arguments: | ||
| * bin - a binary expression to decode | ||
| * charset - one of the charsets 'US-ASCII', 'ISO-8859-1', 'UTF-8', 'UTF-16BE', 'UTF-16LE', 'UTF-16' to decode `bin` into a STRING. It is case insensitive. |
Contributor
There was a problem hiding this comment.
This is a bit tricky because there are two different sets of parameters.
Member
Author
There was a problem hiding this comment.
argument names are unique, right? Otherwise what would you propose?
Contributor
There was a problem hiding this comment.
I have no idea. Maybe we can list all and add note to give the detail.
cc @cloud-fan
Contributor
There was a problem hiding this comment.
We can add named arguments support for this function. But it's unrelated to this PR.
dongjoon-hyun
approved these changes
Dec 4, 2023
cloud-fan
approved these changes
Dec 4, 2023
Member
|
Merged to master. |
asl3
pushed a commit
to asl3/spark
that referenced
this pull request
Dec 5, 2023
### What changes were proposed in this pull request? In the PR, I propose to update the description of the `StringDecode` expression and apparently the `decode()` function by describing the arguments `bin` and `charset`. #### The updated docs: <img width="743" alt="Screenshot 2023-12-04 at 12 24 36" src="https://github.com/apache/spark/assets/1580697/a177f81d-2f39-45ff-bc28-b217dad4e128"> ### Why are the changes needed? To improve user experience with Spark SQL by documenting the public function. ### Does this PR introduce _any_ user-facing change? No. ### How was this patch tested? By manually checking the generated docs. ### Was this patch authored or co-authored using generative AI tooling? No. Closes apache#44157 from MaxGekk/doc-decode-params. Authored-by: Max Gekk <max.gekk@gmail.com> Signed-off-by: Hyukjin Kwon <gurwls223@apache.org>
dbatomic
pushed a commit
to dbatomic/spark
that referenced
this pull request
Dec 11, 2023
### What changes were proposed in this pull request? In the PR, I propose to update the description of the `StringDecode` expression and apparently the `decode()` function by describing the arguments `bin` and `charset`. #### The updated docs: <img width="743" alt="Screenshot 2023-12-04 at 12 24 36" src="https://github.com/apache/spark/assets/1580697/a177f81d-2f39-45ff-bc28-b217dad4e128"> ### Why are the changes needed? To improve user experience with Spark SQL by documenting the public function. ### Does this PR introduce _any_ user-facing change? No. ### How was this patch tested? By manually checking the generated docs. ### Was this patch authored or co-authored using generative AI tooling? No. Closes apache#44157 from MaxGekk/doc-decode-params. Authored-by: Max Gekk <max.gekk@gmail.com> Signed-off-by: Hyukjin Kwon <gurwls223@apache.org>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
What changes were proposed in this pull request?
In the PR, I propose to update the description of the
StringDecodeexpression and apparently thedecode()function by describing the argumentsbinandcharset.The updated docs:
Why are the changes needed?
To improve user experience with Spark SQL by documenting the public function.
Does this PR introduce any user-facing change?
No.
How was this patch tested?
By manually checking the generated docs.
Was this patch authored or co-authored using generative AI tooling?
No.