Skip to content

[SPARK-58758][DOCS] Remove the stale Highlights in 3.0 section from the ML guide - #57987

Closed
uros-b wants to merge 1 commit into
apache:masterfrom
uros-b:doc-mlguide-stale-highlights
Closed

uros-b wants to merge 1 commit into
apache:masterfrom
uros-b:doc-mlguide-stale-highlights

Conversation

@uros-b

@uros-b uros-b commented Aug 13, 2026

Copy link
Copy Markdown
Member

What changes were proposed in this pull request?

Removes the Highlights in 3.0 section from docs/ml-guide.md, and rewrites a sentence that still described DataFrame-based API feature parity as future work in the Spark 2.x releases.

Why are the changes needed?

Both are stale on the current codebase. The guide keeps no equivalent Highlights section for 1.x or 2.x, so dropping superseded highlights is the established practice: SPARK-30934 replaced the 2.3 highlights with the 3.0 ones rather than accumulating them. The Migration Guide section immediately below already points readers to the archived migration guide, and the 3.0 features remain documented on their own pages, so no user-facing information is lost. Feature parity between the DataFrame-based and RDD-based APIs was reached at Spark 2.3, as ml-pipeline.md states, so the future-tense sentence is corrected to past tense.

Does this PR introduce any user-facing change?

No, other than the updated documentation.

How was this patch tested?

Documentation only. No internal doc links point at the removed section's anchor, and the surrounding sections remain well-formed after the deletion.

Was this patch authored or co-authored using generative AI tooling?

Generated-by: Claude Code (Opus 4.8)

@uros-b uros-b left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @HyukjinKwon!

@uros-b uros-b closed this in 99b57f9 Aug 13, 2026
uros-b added a commit that referenced this pull request Aug 13, 2026
…e ML guide

### What changes were proposed in this pull request?

Removes the `Highlights in 3.0` section from `docs/ml-guide.md`, and rewrites a sentence that still described DataFrame-based API feature parity as future work in the Spark 2.x releases.

### Why are the changes needed?

Both are stale on the current codebase. The guide keeps no equivalent `Highlights` section for 1.x or 2.x, so dropping superseded highlights is the established practice: SPARK-30934 replaced the 2.3 highlights with the 3.0 ones rather than accumulating them. The `Migration Guide` section immediately below already points readers to the archived migration guide, and the 3.0 features remain documented on their own pages, so no user-facing information is lost. Feature parity between the DataFrame-based and RDD-based APIs was reached at Spark 2.3, as `ml-pipeline.md` states, so the future-tense sentence is corrected to past tense.

### Does this PR introduce _any_ user-facing change?

No, other than the updated documentation.

### How was this patch tested?

Documentation only. No internal doc links point at the removed section's anchor, and the surrounding sections remain well-formed after the deletion.

### Was this patch authored or co-authored using generative AI tooling?

Generated-by: Claude Code (Opus 4.8)

Closes #57987 from uros-b/doc-mlguide-stale-highlights.

Authored-by: Uros Bojanic <221401595+uros-b@users.noreply.github.com>
Signed-off-by: Uros Bojanic <221401595+uros-b@users.noreply.github.com>
(cherry picked from commit 99b57f9)
Signed-off-by: Uros Bojanic <221401595+uros-b@users.noreply.github.com>
uros-b added a commit that referenced this pull request Aug 13, 2026
…e ML guide

### What changes were proposed in this pull request?

Removes the `Highlights in 3.0` section from `docs/ml-guide.md`, and rewrites a sentence that still described DataFrame-based API feature parity as future work in the Spark 2.x releases.

### Why are the changes needed?

Both are stale on the current codebase. The guide keeps no equivalent `Highlights` section for 1.x or 2.x, so dropping superseded highlights is the established practice: SPARK-30934 replaced the 2.3 highlights with the 3.0 ones rather than accumulating them. The `Migration Guide` section immediately below already points readers to the archived migration guide, and the 3.0 features remain documented on their own pages, so no user-facing information is lost. Feature parity between the DataFrame-based and RDD-based APIs was reached at Spark 2.3, as `ml-pipeline.md` states, so the future-tense sentence is corrected to past tense.

### Does this PR introduce _any_ user-facing change?

No, other than the updated documentation.

### How was this patch tested?

Documentation only. No internal doc links point at the removed section's anchor, and the surrounding sections remain well-formed after the deletion.

### Was this patch authored or co-authored using generative AI tooling?

Generated-by: Claude Code (Opus 4.8)

Closes #57987 from uros-b/doc-mlguide-stale-highlights.

Authored-by: Uros Bojanic <221401595+uros-b@users.noreply.github.com>
Signed-off-by: Uros Bojanic <221401595+uros-b@users.noreply.github.com>
(cherry picked from commit 99b57f9)
Signed-off-by: Uros Bojanic <221401595+uros-b@users.noreply.github.com>
@uros-b

uros-b commented Aug 13, 2026

Copy link
Copy Markdown
Member Author

Merge Summary:

Posted by merge_spark_pr.py

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants