You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by "MaxGekk (via GitHub)" <gi...@apache.org> on 2023/12/04 09:35:35 UTC
[PR] [WIP][SQL][DOCS] Describe arguments of `decode()` [spark]
MaxGekk opened a new pull request, #44157:
URL: https://github.com/apache/spark/pull/44157
### 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:
TODO
### 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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46243][SQL][DOCS] Describe arguments of `decode()` [spark]
Posted by "beliefer (via GitHub)" <gi...@apache.org>.
beliefer commented on code in PR #44157:
URL: https://github.com/apache/spark/pull/44157#discussion_r1413780878
##########
sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/stringExpressions.scala:
##########
@@ -2594,6 +2594,11 @@ object Decode {
the corresponding result. If no match is found, then it returns default. If default
is omitted, it returns null.
""",
+ 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.
Review Comment:
This is a bit tricky because there are two different sets of parameters.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46243][SQL][DOCS] Describe arguments of `decode()` [spark]
Posted by "MaxGekk (via GitHub)" <gi...@apache.org>.
MaxGekk commented on code in PR #44157:
URL: https://github.com/apache/spark/pull/44157#discussion_r1413790776
##########
sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/stringExpressions.scala:
##########
@@ -2594,6 +2594,11 @@ object Decode {
the corresponding result. If no match is found, then it returns default. If default
is omitted, it returns null.
""",
+ 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.
Review Comment:
argument names are unique, right? Otherwise what would you propose?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46243][SQL][DOCS] Describe arguments of `decode()` [spark]
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon closed pull request #44157: [SPARK-46243][SQL][DOCS] Describe arguments of `decode()`
URL: https://github.com/apache/spark/pull/44157
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46243][SQL][DOCS] Describe arguments of `decode()` [spark]
Posted by "beliefer (via GitHub)" <gi...@apache.org>.
beliefer commented on code in PR #44157:
URL: https://github.com/apache/spark/pull/44157#discussion_r1413832030
##########
sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/stringExpressions.scala:
##########
@@ -2594,6 +2594,11 @@ object Decode {
the corresponding result. If no match is found, then it returns default. If default
is omitted, it returns null.
""",
+ 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.
Review Comment:
I'm no idea. Maybe we can list all and add note to give the detail.
cc @cloud-fan
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46243][SQL][DOCS] Describe arguments of `decode()` [spark]
Posted by "cloud-fan (via GitHub)" <gi...@apache.org>.
cloud-fan commented on code in PR #44157:
URL: https://github.com/apache/spark/pull/44157#discussion_r1414251756
##########
sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/stringExpressions.scala:
##########
@@ -2594,6 +2594,11 @@ object Decode {
the corresponding result. If no match is found, then it returns default. If default
is omitted, it returns null.
""",
+ 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.
Review Comment:
We can add named arguments support for this function. But it's unrelated to this PR.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46243][SQL][DOCS] Describe arguments of `decode()` [spark]
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on PR #44157:
URL: https://github.com/apache/spark/pull/44157#issuecomment-1839719960
Merged to master.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
Re: [PR] [SPARK-46243][SQL][DOCS] Describe arguments of `decode()` [spark]
Posted by "beliefer (via GitHub)" <gi...@apache.org>.
beliefer commented on code in PR #44157:
URL: https://github.com/apache/spark/pull/44157#discussion_r1413832030
##########
sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/stringExpressions.scala:
##########
@@ -2594,6 +2594,11 @@ object Decode {
the corresponding result. If no match is found, then it returns default. If default
is omitted, it returns null.
""",
+ 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.
Review Comment:
I have no idea. Maybe we can list all and add note to give the detail.
cc @cloud-fan
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org