Skip to content

Fix incorrect javadoc references in ContextStorageProvider and ContextKey - #8714

Open
thswlsqls wants to merge 1 commit into
open-telemetry:mainfrom
thswlsqls:docs/fix-context-javadoc-references
Open

Fix incorrect javadoc references in ContextStorageProvider and ContextKey#8714
thswlsqls wants to merge 1 commit into
open-telemetry:mainfrom
thswlsqls:docs/fix-context-javadoc-references

Conversation

@thswlsqls

Copy link
Copy Markdown
Contributor

Description

  • ContextStorageProvider: the gRPC link text said io.grpc.context.Context, which does not exist — grpc-java declares the class in package io.grpc, and the href on the same line already points at io/grpc/Context.html. (grpc-context is the Maven artifactId, not the package.)
  • ContextKey: values of type {@link T} renders as values of type ContextKey, because javadoc resolves the type variable T to the type that declares it, so the sentence says something untrue. No invalid-tag warning is emitted — the reference resolves, just to the wrong thing. {@code T} renders the letter as intended.

Testing done

  • Docs-only, test-exempt: no test added; ./gradlew :context:check passed.
  • Checked the rendered output with ./gradlew :context:javadoc --rerun-tasks: ContextKey.html now reads values of type <code>T</code>, and ContextStorageProvider.html shows io.grpc.Context.
  • No public signature change, so docs/apidiffs/current_vs_latest/ is unchanged.

@thswlsqls
thswlsqls marked this pull request as ready for review August 10, 2026 00:40
@thswlsqls
thswlsqls requested a review from a team as a code owner August 10, 2026 00:40
@opentelemetry-pr-dashboard

opentelemetry-pr-dashboard Bot commented Aug 10, 2026

Copy link
Copy Markdown

Pull request dashboard status

Waiting on reviewers · refreshed 2026-08-10 01:36 UTC

Review the latest changes.

Status above doesn't look right?
  • Just replied or pushed? Anything around or after the refresh time above may not be picked up yet — give it a few minutes.
  • Anything look wrong? Report it with what you expected; it helps us improve the dashboard.

@codecov

codecov Bot commented Aug 10, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.65%. Comparing base (d948e13) to head (666f49f).

Additional details and impacted files
@@            Coverage Diff            @@
##               main    #8714   +/-   ##
=========================================
  Coverage     91.65%   91.65%           
  Complexity    10352    10352           
=========================================
  Files          1003     1003           
  Lines         27210    27210           
  Branches       3199     3199           
=========================================
  Hits          24939    24939           
  Misses         1566     1566           
  Partials        705      705           

☔ 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