[MINOR][SQL] Fix incorrect type wording in Row getter scaladoc#57240
Closed
LuciferYang wants to merge 1 commit into
Closed
[MINOR][SQL] Fix incorrect type wording in Row getter scaladoc#57240LuciferYang wants to merge 1 commit into
LuciferYang wants to merge 1 commit into
Conversation
### What changes were proposed in this pull request? Fixes copy-pasted type wording in the scaladoc of several `Row` getters in the sql-api module. The phrase "value at position i of `<type>` type" was copy-pasted from the date getters onto getters that return other types: - `getGeometry`: "of date type" -> "of geometry type" - `getGeography`: "of date type" -> "of geography type" - `getTimestamp` / `getInstant`: "of date type" -> "of timestamp type" - `getJavaMap`: "of array type" -> "of map type" ### Why are the changes needed? The type wording on these getters was incorrect (copy-pasted from sibling getters), which is misleading in the generated API docs. ### Does this PR introduce _any_ user-facing change? No. Documentation-only; no behavior change. ### How was this patch tested? No tests needed (documentation only). ### Was this patch authored or co-authored using generative AI tooling? Generated-by: Ducc
MaxGekk
approved these changes
Jul 14, 2026
MaxGekk
left a comment
MaxGekk
left a comment
Member
There was a problem hiding this comment.
LGTM. I verified each reworded getter's Scaladoc now matches its actual return type (getGeometry→geometry, getGeography→geography, getTimestamp/getInstant→timestamp, getJavaMap→map) and lines up with the sibling getters' convention (getDate/getLocalDate=date, getSeq/getList=array, getMap=map, getStruct=struct).
I also checked for anything similar left to fix: grepping the rest of Row.scala shows no other "of <wrong> type" mismatch remains, and the pattern doesn't appear in any other hand-written source file (the only other occurrences are in the generated sql/api/target/java/.../Row.java, which regenerates from this source). So the fix is complete.
HyukjinKwon
approved these changes
Jul 14, 2026
dongjoon-hyun
approved these changes
Jul 14, 2026
dongjoon-hyun
left a comment
dongjoon-hyun
left a comment
Member
There was a problem hiding this comment.
BTW, we had better get a JIRA ID because we need to backport this, @LuciferYang .
uros-b
approved these changes
Jul 14, 2026
uros-b
left a comment
uros-b
left a comment
Member
There was a problem hiding this comment.
Thank you for the fix @LuciferYang!
LuciferYang
added a commit
that referenced
this pull request
Jul 17, 2026
### What changes were proposed in this pull request? Fixes copy-pasted type wording in the scaladoc of several `Row` getters in the sql-api module. The phrase "value at position i of `<type>` type" had been copy-pasted from the date getters onto getters that return other types: - `getGeometry`: "of date type" -> "of geometry type" - `getGeography`: "of date type" -> "of geography type" - `getTimestamp` / `getInstant`: "of date type" -> "of timestamp type" - `getJavaMap`: "of array type" -> "of map type" ### Why are the changes needed? The type wording on these getters was incorrect (copy-pasted from sibling getters), which is misleading in the generated API docs. ### Does this PR introduce _any_ user-facing change? No. Documentation-only; no behavior change. ### How was this patch tested? No tests needed (documentation only). ### Was this patch authored or co-authored using generative AI tooling? Generated-by: Claude Code(Opus 4.8) Closes #57240 from LuciferYang/SPARK-tier3-scaladoc-cleanup. Authored-by: YangJie <yangjie01@baidu.com> Signed-off-by: yangjie01 <yangjie01@baidu.com> (cherry picked from commit 2abe31b) Signed-off-by: yangjie01 <yangjie01@baidu.com>
Contributor
Author
Contributor
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
5 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?
Fixes copy-pasted type wording in the scaladoc of several
Rowgetters in the sql-api module. The phrase "value at position i of<type>type" had been copy-pasted from the date getters onto getters that return other types:getGeometry: "of date type" -> "of geometry type"getGeography: "of date type" -> "of geography type"getTimestamp/getInstant: "of date type" -> "of timestamp type"getJavaMap: "of array type" -> "of map type"Why are the changes needed?
The type wording on these getters was incorrect (copy-pasted from sibling getters), which is misleading in the generated API docs.
Does this PR introduce any user-facing change?
No. Documentation-only; no behavior change.
How was this patch tested?
No tests needed (documentation only).
Was this patch authored or co-authored using generative AI tooling?
Generated-by: Claude Code(Opus 4.8)