Skip to content

Fix OtelInternalJavadoc diagnostic message to match the contains check#8590

Draft
thswlsqls wants to merge 1 commit into
open-telemetry:mainfrom
thswlsqls:fix/internal-javadoc-diagnostic-message
Draft

Fix OtelInternalJavadoc diagnostic message to match the contains check#8590
thswlsqls wants to merge 1 commit into
open-telemetry:mainfrom
thswlsqls:fix/internal-javadoc-diagnostic-message

Conversation

@thswlsqls

Copy link
Copy Markdown
Contributor

Fixes #8589

Description

  • OtelInternalJavadoc matches when the internal disclaimer is absent using javadoc.contains(...) (lines 53-56), but the @BugPattern summary said the class "doesn't end with" the disclaimer.
  • Changed the summary to "doesn't contain", so the message describes what the check verifies.
  • This aligns with the sibling OtelImplJavadoc, which already describes the same .contains() logic accurately ("is missing the required javadoc disclaimer").

Testing done

  • Updated the three // BUG: Diagnostic contains: assertions in OtelInternalJavadocTest#positiveCases to match the new message.
  • ./gradlew :custom-checks:check — passed.
  • custom-checks is an unpublished build module (no maven-publish), so there is no japicmp/apidiff and no CHANGELOG entry (the message is build-time contributor-facing, not user-facing).

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.

OtelInternalJavadoc diagnostic message says "doesn't end with" but the check uses contains

1 participant