API: Add Javadoc for the Metrics constructor parameters - #17608
Open
uros-b wants to merge 1 commit into
Open
Conversation
Document each parameter of the canonical Metrics constructor, including that the maps and counts may be null when unknown.
uros-b
commented
Aug 11, 2026
uros-b
left a comment
uros-b
left a comment
Member
Author
There was a problem hiding this comment.
Waiting for CI to turn green, but should be good
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
1 participant
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.
The
Metricsconstructors 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.The maps and counts are all optional —
Metrics()leaves everything null and the shorter constructors pass null for the arguments they omit — so each@paramsays so explicitly. Javadoc-only; no signature change.Note: draft #17451 adds an
avgValueSizesparameter to this same constructor. Whichever lands first, the other rebases with a one-line adjustment (an added@paramthere, or a trivial context shift here).