Skip to content

Fix copy-paste leftovers in public API javadoc - #8693

Draft
thswlsqls wants to merge 1 commit into
open-telemetry:mainfrom
thswlsqls:docs/fix-api-javadoc-copypasta
Draft

Fix copy-paste leftovers in public API javadoc#8693
thswlsqls wants to merge 1 commit into
open-telemetry:mainfrom
thswlsqls:docs/fix-api-javadoc-copypasta

Conversation

@thswlsqls

Copy link
Copy Markdown
Contributor

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 from LongCounterBuilder#ofDoubles, where it is correct).
  • TraceId#fromBytes: "first 26 bytes" → 16, matching BYTES_LENGTH and the @param right below (cf. SpanId#fromBytes, "first 8 bytes").
  • TraceFlags#isSampled: a * trapped inside {@code} rendered as otherwise * false (cf. isTraceIdRandom, same file).
  • TraceFlags#asHex: @return said "the byte representation", copied from asByte; returns String.
  • TraceId#fromLongs: summary said "the bytes (16-byte array) representation"; returns String, and its own @return already says hex (cf. SpanId#fromLong).

Testing done

  • Docs-only, test-exempt: no test added.
  • ./gradlew :api:all:check passed.
  • ./gradlew :api:all:javadoc --rerun-tasks: the stray * is gone from TraceFlags.html, and TraceId.html now reads "lowercase hex (base16) representation" for fromLongs.
  • No apidiff change: javadoc does not reach bytecode.
  • Not run: *IT and GraalVM native-image tests (outside check).

@codecov

codecov Bot commented Aug 5, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.62%. Comparing base (dd811c4) to head (baf2d6b).

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant