Skip to content

Delta: Fix invalid @Returns Javadoc tag in SnapshotDeltaLakeTable#16887

Open
thswlsqls wants to merge 1 commit into
apache:mainfrom
thswlsqls:docs/delta-snapshot-return-javadoc
Open

Delta: Fix invalid @Returns Javadoc tag in SnapshotDeltaLakeTable#16887
thswlsqls wants to merge 1 commit into
apache:mainfrom
thswlsqls:docs/delta-snapshot-return-javadoc

Conversation

@thswlsqls

@thswlsqls thswlsqls commented Jun 20, 2026

Copy link
Copy Markdown
Contributor

Summary

  • The as, icebergCatalog, and deltaLakeConfiguration builder methods appended @Returns this for method chaining to their @param line.
  • @Returns is not a valid Javadoc tag, so the return value was never documented.
  • Replaced it with a @return this for method chaining line, matching the sibling methods tableProperties, tableProperty, and tableLocation in the same interface (lines 38, 48, 57), which already use @return on its own line.
  • File: delta-lake/src/main/java/org/apache/iceberg/delta/SnapshotDeltaLakeTable.java.

Testing done

  • Docs/comment-only change, no behavior change — no test added. ./gradlew :iceberg-delta-lake:spotlessCheck passed.

AI Disclosure

  • Model: Claude Opus 4.8
  • Platform/Tool: Claude Code

Three builder methods documented their return value as
"@param ... @returns this for method chaining". @returns is not a
valid Javadoc tag, so the return description was dropped. Use the
@return tag on its own line, matching the sibling methods in the
same interface.

Generated-by: Claude Code
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