[SPARK-58661][SQL][DOCS] Document return values and fix stale column references in DataFrameStatFunctions - #57868
Closed
uros-b wants to merge 1 commit into
Closed
[SPARK-58661][SQL][DOCS] Document return values and fix stale column references in DataFrameStatFunctions#57868uros-b wants to merge 1 commit into
uros-b wants to merge 1 commit into
Conversation
uros-b
commented
Aug 8, 2026
uros-b
left a comment
uros-b
left a comment
Member
Author
There was a problem hiding this comment.
@zhengruifeng Please review.
Member
Author
|
Thank you @dongjoon-hyun! |
uros-b
added a commit
that referenced
this pull request
Aug 9, 2026
…eferences in DataFrameStatFunctions ### What changes were proposed in this pull request? Two scaladoc fixes in `DataFrameStatFunctions`: 1. Adds the missing `return` tag to the four `bloomFilter` overloads. 2. Corrects the `return` text of the two `countMinSketch(col: Column, ...)` overloads, which described the result as being over column `colName` even though those overloads declare `col`. ### Why are the changes needed? The `countMinSketch` overloads all document their return value while the parallel `bloomFilter` overloads document none, so the published API docs are inconsistent between two families of methods that the file otherwise describes in parallel wording. Each added tag names the parameter its own overload declares, alternating `colName`/`col` to match the four signatures. The two stale `colName` references are a copy-paste artifact of the unified Scala interface refactor: the text was carried over from the `colName: String` overloads without being updated for the `Column` ones. The `colName` overloads themselves are correct and are left untouched. ### Does this PR introduce _any_ user-facing change? No, other than the corrected API documentation. ### How was this patch tested? Scaladoc only, so no behavior to test. Stripping comments from the file before and after the change yields byte-identical source, confirming no signature or code change and no binary compatibility impact. ### Was this patch authored or co-authored using generative AI tooling? Generated-by: Claude Code (Opus 4.8) Closes #57868 from uros-b/apidoc-dataframestatfunctions. 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 e9fbec7) Signed-off-by: Uros Bojanic <221401595+uros-b@users.noreply.github.com>
uros-b
added a commit
that referenced
this pull request
Aug 9, 2026
…eferences in DataFrameStatFunctions ### What changes were proposed in this pull request? Two scaladoc fixes in `DataFrameStatFunctions`: 1. Adds the missing `return` tag to the four `bloomFilter` overloads. 2. Corrects the `return` text of the two `countMinSketch(col: Column, ...)` overloads, which described the result as being over column `colName` even though those overloads declare `col`. ### Why are the changes needed? The `countMinSketch` overloads all document their return value while the parallel `bloomFilter` overloads document none, so the published API docs are inconsistent between two families of methods that the file otherwise describes in parallel wording. Each added tag names the parameter its own overload declares, alternating `colName`/`col` to match the four signatures. The two stale `colName` references are a copy-paste artifact of the unified Scala interface refactor: the text was carried over from the `colName: String` overloads without being updated for the `Column` ones. The `colName` overloads themselves are correct and are left untouched. ### Does this PR introduce _any_ user-facing change? No, other than the corrected API documentation. ### How was this patch tested? Scaladoc only, so no behavior to test. Stripping comments from the file before and after the change yields byte-identical source, confirming no signature or code change and no binary compatibility impact. ### Was this patch authored or co-authored using generative AI tooling? Generated-by: Claude Code (Opus 4.8) Closes #57868 from uros-b/apidoc-dataframestatfunctions. 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 e9fbec7) Signed-off-by: Uros Bojanic <221401595+uros-b@users.noreply.github.com>
Member
Author
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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?
Two scaladoc fixes in
DataFrameStatFunctions:@returntag to the fourbloomFilteroverloads.@returntext of the twocountMinSketch(col: Column, ...)overloads, which described the result as being over columncolNameeven though those overloads declarecol.Why are the changes needed?
The
countMinSketchoverloads all document their return value while the parallelbloomFilteroverloads document none, so the published API docs are inconsistent between two families of methods that the file otherwise describes in parallel wording. Each added tag names the parameter its own overload declares, alternatingcolName/colto match the four signatures.The two stale
colNamereferences are a copy-paste artifact of the unified Scala interface refactor: the text was carried over from thecolName: Stringoverloads without being updated for theColumnones. ThecolNameoverloads themselves are correct and are left untouched.Does this PR introduce any user-facing change?
No, other than the corrected API documentation.
How was this patch tested?
Scaladoc only, so no behavior to test. Stripping comments from the file before and after the change yields byte-identical source, confirming no signature or code change and no binary compatibility impact.
Was this patch authored or co-authored using generative AI tooling?
Generated-by: Claude Code (Opus 4.8)