Uh oh!
There was an error while loading. Please reload this page.
[MINOR][PYTHON][DOCS] Fixed some links in documentation. - #57359
[MINOR][PYTHON][DOCS] Fixed some links in documentation.#57359art000109 wants to merge 9 commits into
Conversation
### What changes were proposed in this pull request? Fixed some links in DataFrame and Pandas-On-Spark-DataFrame classes. ### 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.
| pandas-on-Spark DataFrame that corresponds to pandas DataFrame logically. This holds Spark | ||
| DataFrame internally. | ||
| .. versionadded:: 3.2.0 |
There was a problem hiding this comment.
Was this added 3.2.0? Also, I think versionchanged directive as for the new parameter
There was a problem hiding this comment.
yes, Pandas API was added in SPARK-34849 for 3.2.0
There was a problem hiding this comment.
This API calls the DataFrame.pandas_api function, which was added in version 3.2.0 https://github.com/apache/spark/blob/master/python/pyspark/sql/dataframe.py#L6463
| "DataFrameWriterV2", | ||
| "MergeIntoWriter", | ||
| "DataStreamReader", | ||
| "DataStreamWriter", |
There was a problem hiding this comment.
DataStreamReader / DataStreamWriter technically are not API so we don't need this
There was a problem hiding this comment.
Okay, I've removed that block
| See Also | ||
| -------- | ||
| pyspark.pandas.frame.DataFrame.to_spark | ||
| pyspark.pandas.DataFrame.to_spark |
Uh oh!
There was an error while loading. Please reload this page.
| extraction : | ||
| index to check for in array or key to check for in map | ||
| Returns |
There was a problem hiding this comment.
I am documenting them in #57185. Let's avoid those changes for now
There was a problem hiding this comment.
Oh, sorry. I've deleted this block
There was a problem hiding this comment.
Yes, of course. Sorry about the conflict. I'll revert the changes to this file. Can we split this PR and I'll make another one after yours?
HyukjinKwon
commented
Jul 20, 2026
Let's file a JIRA |
art000109
commented
Jul 21, 2026
@HyukjinKwon I reverted the changes to the builtins.py file. Can I ask you to create a card in Jira? I don't have access to it. |
HyukjinKwon
left a comment
There was a problem hiding this comment.
1 blocking, 0 non-blocking, 0 nits.
A clean documentation link cleanup. One added link is missing its reST closing underscore, so it will render as literal text rather than a hyperlink.
Correctness (1)
- python/pyspark/sql/dataframe.py:1209: The new
Hintslink is missing the trailing_, so Sphinx renders it as literal text with visible backticks instead of a link. -- see inline
Verification
Checked all 5 changed files: the ~pyspark.sql.DataFrame cross-references in tvf.py, the ~pyspark.sql.functions.ArrowUDFType shortening in pandas/functions.py, and the pyspark.pandas.DataFrame.to_spark fix in dataframe.py are all correct (verified pyspark.pandas.DataFrame is the public alias exposing to_spark). The core_classes.rst autosummary additions and the frame.py directive relocation are valid. Only the hint() link has a reST syntax defect.
Uh oh!
There was an error while loading. Please reload this page.
Thank you Co-authored-by: Hyukjin Kwon <gurwls223@gmail.com>
art000109
commented
Jul 21, 2026
@HyukjinKwon Thank you for review! I applied your last suggestion. Is it necessary to create a Jira ticket for the PR? I don't have the permissions to do so. |
### What changes were proposed in this pull request? Fixed some links in DataFrame and Pandas-On-Spark-DataFrame classes. ### 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. Closes#57359 from art000109/master. Lead-authored-by: art000109 <59031761+art000109@users.noreply.github.com> Co-authored-by: Artem Kozhin <artlkoa34@gmail.com> Signed-off-by: Hyukjin Kwon <hyukjin.kwon@databricks.com> (cherry picked from commit c198adc) Signed-off-by: Hyukjin Kwon <hyukjin.kwon@databricks.com>
HyukjinKwon
commented
Jul 21, 2026
@art000109@HyukjinKwon please open a separate pr to fix the doc failure |
What changes were proposed in this pull request?
Fixed some links in DataFrame and Pandas-On-Spark-DataFrame classes.
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.