Skip to content

API: Fix incorrect Javadoc on ManageSnapshots tag methods - #17243

Merged
singhpk234 merged 1 commit into
apache:mainfrom
thswlsqls:docs/manage-snapshots-tag-javadoc
Jul 18, 2026
Merged

API: Fix incorrect Javadoc on ManageSnapshots tag methods#17243
singhpk234 merged 1 commit into
apache:mainfrom
thswlsqls:docs/manage-snapshots-tag-javadoc

Conversation

@thswlsqls

Copy link
Copy Markdown
Contributor

Summary

  • createTag(String, long): @param snapshotId said "head of the new branch"; corrected to "tag".
  • removeTag(String): @throws IllegalArgumentException said "if the branch does not exist"; corrected to "tag".
  • Both are copy-paste leftovers from the sibling createBranch(String, long) and removeBranch(String) Javadoc, which are the correct anchors.

Testing done

  • Typo/wording fix, no behavior change — no test added. ./gradlew :iceberg-api:spotlessCheck passed.

createTag's @param snapshotId said "head of the new branch" and
removeTag's @throws said "if the branch does not exist". Both are
copy-paste leftovers from the sibling branch methods; corrected to
refer to the tag.

Generated-by: Claude Code
@github-actions github-actions Bot added the API label Jul 16, 2026

@singhpk234 singhpk234 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM, thanks @thswlsqls for change and @ebyhr for review

@singhpk234
singhpk234 merged commit 0a1db66 into apache:main Jul 18, 2026
38 checks passed
@thswlsqls
thswlsqls deleted the docs/manage-snapshots-tag-javadoc branch July 21, 2026 08:13
@nssalian nssalian added this to the Iceberg 1.12.0 milestone Jul 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants