Skip to content

API: Add Javadoc for the Metrics constructor parameters - #17608

Open
uros-b wants to merge 4 commits into
apache:mainfrom
uros-b:api-add-metrics-constructor-javadoc
Open

API: Add Javadoc for the Metrics constructor parameters#17608
uros-b wants to merge 4 commits into
apache:mainfrom
uros-b:api-add-metrics-constructor-javadoc

Conversation

@uros-b

@uros-b uros-b commented Aug 11, 2026

Copy link
Copy Markdown
Member

The Metrics constructors have no Javadoc, so it isn't documented what each map holds or that they may be null. This documents the canonical constructor that the other three delegate to. Javadoc-only; no signature change.

Document each parameter of the canonical Metrics constructor, including that the maps and counts may be null when unknown.
@github-actions github-actions Bot added the API label Aug 11, 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.

Waiting for CI to turn green, but should be good

Comment thread api/src/main/java/org/apache/iceberg/Metrics.java Outdated
Co-authored-by: Anoop Johnson <git@anoopjohnson.com>
@uros-b

uros-b commented Aug 13, 2026

Copy link
Copy Markdown
Member Author

cc @nastra PTAL

Comment thread api/src/main/java/org/apache/iceberg/Metrics.java
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