Fix SpanLimitsBuilder Javadoc to match non-negative argument check#8516
Draft
thswlsqls wants to merge 1 commit into
Draft
Fix SpanLimitsBuilder Javadoc to match non-negative argument check#8516thswlsqls wants to merge 1 commit into
thswlsqls wants to merge 1 commit into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #8516 +/- ##
============================================
- Coverage 78.77% 78.76% -0.01%
+ Complexity 8579 8578 -1
============================================
Files 1009 1009
Lines 28993 28993
Branches 3599 3599
============================================
- Hits 22839 22837 -2
- Misses 5311 5312 +1
- Partials 843 844 +1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
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.
Fixes #8515
Description
SpanLimitsBuilder's five count setters documented@param ... Must be positive.and@throws IllegalArgumentException if {@code ...} is not positive., but each checksvalue >= 0("must be non-negative") and accepts 0.setMaxNumberOfAttributes,setMaxNumberOfEvents,setMaxNumberOfLinks,setMaxNumberOfAttributesPerEvent, andsetMaxNumberOfAttributesPerLink.setMaxAttributeValueLength, which already documents the same>= 0check correctly.>= 0behavior is intentional: PR Follow spec on span limits, batch processors #7030 relaxed these checks to follow the spec but left this Javadoc stale.Testing done
./gradlew :sdk:trace:checkpassed (155 actionable tasks; test + spotlessCheck + ErrorProne/NullAway + jApiCmp). Nodocs/apidiffschange (Javadoc only). No CHANGELOG entry (not user-facing).