[SPARK-XXXXX][PYTHON][DOCS] Added Returns and See Also sections in pyspark.sql.functions documentation. - #57529
[SPARK-XXXXX][PYTHON][DOCS] Added Returns and See Also sections in pyspark.sql.functions documentation.#57529art000109 wants to merge 8 commits into
Conversation
…sql.functions documentation. ### What changes were proposed in this pull request? Fixed some links in pyspark.sql.DataFrame, TVF and Pandas-On-Spark-DataFrame classes. Added Returns and See Also sections in pyspark.sql.functions documentation. The documentation for some st_ functions corrected. ### Why are the changes needed? The documentation will be more comprehensive. ### Does this PR introduce any user-facing change? No. This is a documentation-only change. ### How was this patch tested? Manual review. ### Was this patch authored or co-authored using generative AI tooling? No.
|
@HyukjinKwon Hi! This PR is synchronized with #57359 and follows up on another one #57185. References to DataStreamReader/Writer have been removed. Is it possible to trigger the GitHub Pages deployment CI and file a JIRA? I am unable to create a task in JIRA. |
| Returns | ||
| ------- | ||
| :class:`pyspark.sql.conf.RuntimeConfig` | ||
| :class:`~pyspark.sql.conf.RuntimeConfig` |
There was a problem hiding this comment.
Are these required changes?
There was a problem hiding this comment.
No, this is a cosmetic change so that the web version of the documentation does not show the entire class, but only RuntimeConfig, but the link to it remains
|
Let's file a JIRA |
art000109
changed the title
|
@HyukjinKwon I’ve reviewed the documentation tasks in Jira. I suppose we can also close SPARK-48828 [c757a5f, previous PR #47244] and SPARK-57095 [duplicate of SPARK-57116 SPARK-54785, #53548]. |
|
@uros-b Hi! Can I ask you to do a review too? |
2 participants
What changes were proposed in this pull request?
Fixed some links in pyspark.sql.DataFrame, TVF and Pandas-On-Spark-DataFrame, SparkSession classes.
Added Returns and See Also sections in pyspark.sql.functions documentation.
The documentation for some st_ functions corrected.
Shortened links in pandas.group_ops, pandas.functions, functions, SparkContext, SparkSession, DataFrame
Why are the changes needed?
The documentation will be more comprehensive.
Does this PR introduce any user-facing change?
No. This is a documentation-only change.
How was this patch tested?
Manual review.
Was this patch authored or co-authored using generative AI tooling?
No.