[SPARK-53182][PYTHON][DOCS] Fix broken and missing links in PySpark DataFrames user guide #51851
+5
−3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Updated outdated external link to data manipulation section (now Chapter 3) with a working internal link to the official PySpark documentation. - Replaced "TODO: add link" with correct reference to Chapter 7 on data loading.
|
Would you create a JIRA ticket and link to the PR title? Please see https://spark.apache.org/contributing.html |
jonnycomes
changed the title
|
Thanks! I've created the JIRA ticket, updated the PR title accordingly, and added screenshots of the rendered output to the description. This is my first time contributing—thanks for your guidance! |
HyukjinKwon
changed the title
|
cc @asl3 FYI |
HyukjinKwon
changed the title
asl3
approved these changes
Aug 13, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What changes were proposed in this pull request?
This PR fixes two small issues in the PySpark DataFrames user guide:
Replaces a broken external link to a section on data manipulation. The previous link pointed to an outdated Databricks-hosted page. It is now replaced with a working internal link to Chapter 3 of the PySpark user guide:
Chapter 3: Function Junction - Data manipulation with PySpark
Adds a missing link for the section on saving DataFrames to persistent storage. The text previously said “TODO: add link.” This has been replaced with a correct reference to:
Chapter 7: Load and Behold - Data loading, storage, file formats
Why are the changes needed?
These changes improve the quality and usability of the documentation by fixing a broken link and completing a placeholder that may confuse users. It ensures readers are directed to up-to-date, relevant internal documentation instead of an outdated or unavailable external resource.
Does this PR introduce any user-facing change?
Yes. It updates two markdown cells in the
dataframes.ipynbuser guide notebook, affecting how users navigate to related documentation when reading the generated HTML docs.How was this patch tested?
The documentation was built locally using
make htmlin thepython/docsdirectory. The rendered output for the notebook was reviewed in a browser to confirm the links appear and function correctly.Was this patch authored or co-authored using generative AI tooling?
No.