You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by "HyukjinKwon (via GitHub)" <gi...@apache.org> on 2023/11/21 07:06:21 UTC
[PR] [SPARK-46026][PYTHON][DOCS] Refine docstring of UDTF [spark]
HyukjinKwon opened a new pull request, #43928:
URL: https://github.com/apache/spark/pull/43928
### What changes were proposed in this pull request?
This PR proposes to improve the docstring of UDTF.
### Why are the changes needed?
For end users, and better usability of PySpark.
### Does this PR introduce _any_ user-facing change?
Yes, it fixes the user facing documentation.
### How was this patch tested?
Manually tested.
### 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-46026][PYTHON][DOCS] Refine docstring of UDTF [spark]
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon closed pull request #43928: [SPARK-46026][PYTHON][DOCS] Refine docstring of UDTF
URL: https://github.com/apache/spark/pull/43928
--
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-46026][PYTHON][DOCS] Refine docstring of UDTF [spark]
Posted by "allisonwang-db (via GitHub)" <gi...@apache.org>.
allisonwang-db commented on PR #43928:
URL: https://github.com/apache/spark/pull/43928#issuecomment-1821970655
Nice! Thanks for the update.
--
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-46026][PYTHON][DOCS] Refine docstring of UDTF [spark]
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on code in PR #43928:
URL: https://github.com/apache/spark/pull/43928#discussion_r1400213112
##########
python/pyspark/sql/udtf.py:
##########
@@ -82,13 +87,21 @@ class OrderingColumn:
"""
Represents a single ordering column name for purposes of returning metadata from the 'analyze'
method.
+
+ Parameters
+ ----------
+ name : str
+ The name of the partitioning column.
+ ascending : bool, default True
+ If this column is in an ascending order or not.
+ overrideNullsFirst : str, optional
+ If this is None, use the default behavior to sort NULL values first when sorting in ascending
+ order, or last when sorting in descending order. Otherwise, if this is True or False, override
+ the default behavior accordingly.
Review Comment:
```suggestion
If this is None, use the default behavior to sort NULL values first when sorting in
ascending order, or last when sorting in descending order. Otherwise, if this is
True or False, override the default behavior accordingly.
```
--
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-46026][PYTHON][DOCS] Refine docstring of UDTF [spark]
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on PR #43928:
URL: https://github.com/apache/spark/pull/43928#issuecomment-1820349752
cc @ueshin @dtenedor
--
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-46026][PYTHON][DOCS] Refine docstring of UDTF [spark]
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on PR #43928:
URL: https://github.com/apache/spark/pull/43928#issuecomment-1820722597
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-46026][PYTHON][DOCS] Refine docstring of UDTF [spark]
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on code in PR #43928:
URL: https://github.com/apache/spark/pull/43928#discussion_r1400213112
##########
python/pyspark/sql/udtf.py:
##########
@@ -82,13 +87,21 @@ class OrderingColumn:
"""
Represents a single ordering column name for purposes of returning metadata from the 'analyze'
method.
+
+ Parameters
+ ----------
+ name : str
+ The name of the partitioning column.
+ ascending : bool, default True
+ If this column is in an ascending order or not.
+ overrideNullsFirst : str, optional
+ If this is None, use the default behavior to sort NULL values first when sorting in ascending
+ order, or last when sorting in descending order. Otherwise, if this is True or False, override
+ the default behavior accordingly.
Review Comment:
```suggestion
If this is None, use the default behavior to sort NULL values first when sorting in
ascending order, or last when sorting in descending order. Otherwise, if this is
True or False, override the default behavior accordingly.
```
--
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