On Wed, 1 Jun 2022 05:20:22 GMT, Jonathan Gibbons <[email protected]> wrote:
> Please review a trivial fix to remove unnecessary hyphens from compound words
> in comments,
> as suggested in an earlier review.
Looks okay; thanks.
This PR changes hyphenated forms to closed forms. Consider also changing open
forms (e.g. sub package, super interface) to closed forms. We have some of
those in jdk.javadoc.
src/jdk.javadoc/share/classes/jdk/javadoc/doclet/Reporter.java line 52:
> 50: * such as the command-line help that is generated when using a {@code
> --help} option,
> 51: * and "diagnostic output" refers to any errors, warnings and other
> output that is
> 52: * a side effect of executing the operation.
While I'm not saying that your suggestion is incorrect (in fact, my ngram
comparison result supports you), I note that "side-effect" is a prevailing
spelling in JDK.
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/builders/AbstractMemberBuilder.java
line 60:
> 58:
> 59: /**
> 60: * This method is not supported by subbuilders.
Hopefully we'll get rid of this concept and the need for that _shudders_ word
eventually.
-------------
Marked as reviewed by prappo (Reviewer).
PR: https://git.openjdk.java.net/jdk/pull/8964
