[MINOR][PYTHON][DOCS] Fixed some links in documentation.#57359
[MINOR][PYTHON][DOCS] Fixed some links in documentation.#57359art000109 wants to merge 8 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.
art000109
changed the title
| 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 |
There was a problem hiding this comment.
This yes we would need thos
| 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?
|
Let's file a JIRA |
|
@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
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.
| :class:`DataFrame` | ||
| Hinted DataFrame | ||
|
|
||
| .. note:: See also `Hints <https://spark.apache.org/docs/latest/sql-ref-syntax-qry-select-hints.html>` |
There was a problem hiding this comment.
This link is missing the trailing underscore, so reST renders it as literal text (backticks and URL shown verbatim) rather than a hyperlink. External links need the closing `_:
| .. note:: See also `Hints <https://spark.apache.org/docs/latest/sql-ref-syntax-qry-select-hints.html>` | |
| .. note:: See also `Hints <https://spark.apache.org/docs/latest/sql-ref-syntax-qry-select-hints.html>`_ |
Compare the existing links in the codebase, e.g. `NaN Semantics <...>`_ in column.py. Given this PR is specifically fixing doc links, worth getting this one right too.
2 participants
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.