Skip to content

Fix OtelInternalJavadoc diagnostic message to match the contains check #8590

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
thswlsqls wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −4
Draft

Fix OtelInternalJavadoc diagnostic message to match the contains check #8590

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion custom-checks/src/main/java/io/opentelemetry/gradle/customchecks/OtelInternalJavadoc.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

@BugPattern(
summary =
"This public internal class doesn't end with any of the applicable javadoc disclaimers: \""
"This public internal class doesn't contain any of the applicable javadoc disclaimers: \""
+ OtelInternalJavadoc.EXPECTED_INTERNAL_COMMENT_V1
+ "\", or \""
+ OtelInternalJavadoc.EXPECTED_INTERNAL_COMMENT_V2
Expand Down
6 changes: 3 additions & 3 deletions ...om-checks/src/test/java/io/opentelemetry/gradle/customchecks/OtelInternalJavadocTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ void positiveCases() {
" * SPDX-License-Identifier: Apache-2.0",
" */",
"package io.opentelemetry.gradle.customchecks.internal;",
"// BUG: Diagnostic contains: doesn't end with any of the applicable javadoc disclaimers",
"// BUG: Diagnostic contains: doesn't contain any of the applicable javadoc disclaimers",
"public class InternalJavadocPositiveCases {",
" // BUG: Diagnostic contains: doesn't end with any of the applicable javadoc disclaimers",
" // BUG: Diagnostic contains: doesn't contain any of the applicable javadoc disclaimers",
" public static class One {}",
" /** Doesn't have the disclaimer. */",
" // BUG: Diagnostic contains: doesn't end with any of the applicable javadoc disclaimers",
" // BUG: Diagnostic contains: doesn't contain any of the applicable javadoc disclaimers",
" public static class Two {}",
"}")
.doTest();
Expand Down
Loading