Skip to content

API: Add missing @return Javadoc to fluent/namespace method - #17394

Open
uros-b wants to merge 1 commit into
apache:mainfrom
uros-b:api-managesnapshots-return-javadoc
Open

API: Add missing @return Javadoc to fluent/namespace method#17394
uros-b wants to merge 1 commit into
apache:mainfrom
uros-b:api-managesnapshots-return-javadoc

Conversation

@uros-b

@uros-b uros-b commented Jul 28, 2026

Copy link
Copy Markdown
Member

Several public API methods are missing the @return Javadoc tag that their sibling methods document. This adds it for consistency and completeness. Javadoc-only; no signature or behavior change.

@github-actions github-actions Bot added the API label Jul 28, 2026

@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.

@nastra please review

Comment thread api/src/main/java/org/apache/iceberg/ManageSnapshots.java
@uros-b uros-b changed the title API: Add missing @return Javadoc to ManageSnapshots methods API: Add missing @return Javadoc to fluent/namespace method Jul 29, 2026
@uros-b
uros-b requested a review from nastra July 29, 2026 22:28
@uros-b
uros-b force-pushed the api-managesnapshots-return-javadoc branch from 3beeac7 to 3033fa3 Compare July 29, 2026 22:35
@nastra

nastra commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

I did a quick analysis and we have the same pattern in, so we might want to update those places as well to be consistent

  • util/BinaryUtil#truncateBinary(ByteBuffer, int)
  • util/BinaryUtil#truncateBinaryUnsafe(ByteBuffer, int)
  • io/FileIO#properties()
  • formats/ReadBuilder#split(long, long), #caseSensitive(boolean), #filter(Expression) — siblings set/setAll already say "@return this for method chaining"
  • TrackingBuilder#added, #from, #deleted, #replaced
  • TrackedFile#copyWithStats(Set)
  • MetricsConfig#forTable(Table)
  • ManifestFilterManager#buildSummary(Iterable)
  • MergingSnapshotProducer#addedDeleteFiles(...)
  • data/avro/RawDecoder#create(...)
  • encryption/NativeFileCryptoParameters#create(ByteBuffer)
  • io/PartitionedWriter#partition(T) and io/PartitionedFanoutWriter#partition(T)

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.

3 participants