Fix incorrect javadoc references in ContextStorageProvider and ContextKey - #8714
Open
thswlsqls wants to merge 1 commit into
Open
Fix incorrect javadoc references in ContextStorageProvider and ContextKey#8714thswlsqls wants to merge 1 commit into
thswlsqls wants to merge 1 commit into
Conversation
Pull request dashboard statusWaiting on reviewers · refreshed 2026-08-10 01:36 UTC Review the latest changes. Status above doesn't look right?
|
Codecov Report✅ All modified and coverable lines are covered by tests. 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. 🚀 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.
Description
ContextStorageProvider: the gRPC link text saidio.grpc.context.Context, which does not exist — grpc-java declares the class inpackage io.grpc, and thehrefon the same line already points atio/grpc/Context.html. (grpc-contextis the Maven artifactId, not the package.)ContextKey:values of type {@link T}renders asvalues of type ContextKey, because javadoc resolves the type variableTto the type that declares it, so the sentence says something untrue. Noinvalid-tagwarning is emitted — the reference resolves, just to the wrong thing.{@code T}renders the letter as intended.Testing done
./gradlew :context:checkpassed../gradlew :context:javadoc --rerun-tasks:ContextKey.htmlnow readsvalues of type <code>T</code>, andContextStorageProvider.htmlshowsio.grpc.Context.docs/apidiffs/current_vs_latest/is unchanged.