Skip to content

Commit

Permalink
Documentation style guide rules:
Browse files Browse the repository at this point in the history
Don't use "Please"

"Make sure" > "Ensure"
  • Loading branch information
rhaetor authored and ppalaga committed Dec 3, 2024
1 parent 2928e57 commit 33269a9
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ static void java2wsdl(
throw new IllegalStateException("Service class " + serviceClass + " was already selected by\n\n"
+ oldSelectors
+ "\n\nand therefore it cannot once again be selected by\n\n" + selectors
+ "\n\nPlease make sure that the individual include/exclude sets are mutually exclusive.");
+ "\n\nEnsure that the individual include/exclude sets are mutually exclusive.");
}

processedClasses.put(serviceClass.toString(), selectors);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ public static boolean scan(
throw new IllegalStateException("WSDL file " + wsdlFile + " was already selected by\n\n"
+ oldSelectors
+ "\n\nand therefore it cannot once again be selected by\n\n" + selectors
+ "\n\nPlease make sure that the individual include/exclude sets are mutually exclusive.");
+ "\n\nEnsure that the individual include/exclude sets are mutually exclusive.");
}
processedFiles.put(wsdlFile.toString(), selectors);
wsdlFileConsumer.accept(wsdlFile);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ void scanOverlappingSelections() throws IOException {
io.quarkiverse.cxf.deployment.codegen.Wsdl2JavaCodeGen.WSDL2JAVA_CONFIG_KEY_PREFIX + ".my-name",
files,
foundFiles::add))
.withMessageContaining("Please make sure that the individual include/exclude sets are mutually exclusive");
.withMessageContaining("Ensure that the individual include/exclude sets are mutually exclusive");

}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public class IncludesConflictJava2WsTest {
.overrideConfigKey("quarkus.cxf.java2ws.group_02.wsdl-name-template",
"%TARGET_DIR%/" + TEST_DIR + "/%SIMPLE_CLASS_NAME%.wsdl")
.assertException(t -> Assertions.assertThat(t).isInstanceOf(IllegalStateException.class)
.hasMessageContaining("Please make sure that the individual include/exclude sets are mutually exclusive"));
.hasMessageContaining("Ensure that the individual include/exclude sets are mutually exclusive"));

@Test
public void generationTest() throws IOException {
Expand Down

0 comments on commit 33269a9

Please sign in to comment.