Fix copy-paste leftovers in public API javadoc - #8693
Draft
thswlsqls wants to merge 1 commit into
Draft
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #8693 +/- ##
=========================================
Coverage 91.62% 91.62%
Complexity 10327 10327
=========================================
Files 1003 1003
Lines 27138 27138
Branches 3187 3187
=========================================
Hits 24866 24866
Misses 1566 1566
Partials 706 706 ☔ 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.
No issue: docs-only javadoc fix, submitting directly.
Description
Six javadoc lines in stable public API describe something the method does not do. Each fix reuses a sibling member's wording.
DoubleHistogramBuilder#ofLongs: "Sets the Counter" → Histogram (cf.DoubleGaugeBuilder#ofLongs).LongUpDownCounterBuilder#ofDoubles: "Sets the Counter" → UpDownCounter (copied fromLongCounterBuilder#ofDoubles, where it is correct).TraceId#fromBytes: "first 26 bytes" → 16, matchingBYTES_LENGTHand the@paramright below (cf.SpanId#fromBytes, "first 8 bytes").TraceFlags#isSampled: a*trapped inside{@code}rendered asotherwise * false(cf.isTraceIdRandom, same file).TraceFlags#asHex:@returnsaid "the byte representation", copied fromasByte; returnsString.TraceId#fromLongs: summary said "the bytes (16-byte array) representation"; returnsString, and its own@returnalready says hex (cf.SpanId#fromLong).Testing done
./gradlew :api:all:checkpassed../gradlew :api:all:javadoc --rerun-tasks: the stray*is gone fromTraceFlags.html, andTraceId.htmlnow reads "lowercase hex (base16) representation" forfromLongs.*ITand GraalVM native-image tests (outsidecheck).