RFR: 8286654: Add an optional description accessor on ToolProvider interface

Christian Stein cstein at openjdk.java.net
Thu May 19 10:23:18 UTC 2022


On Thu, 19 May 2022 06:21:40 GMT, Christian Stein <cstein at openjdk.org> wrote:

>> src/jdk.compiler/share/classes/com/sun/tools/javac/resources/javac.properties line 387:
>> 
>>> 385: 
>>> 386: javac.description=Read Java declarations and compile them into class files
>>> 387: 
>> 
>> for your general consideration, what grammatical style do you recommend here? Should it be 3rd person (Reads) instead of 2nd person (Read)
>
> I took the phrases in 2nd person style from https://docs.oracle.com/en/java/javase/18/docs/specs/man/ as templates, shortening some of them to around 80 characters for better fitting in standard terminal widths.
> 
> Perhaps, those texts should be used "as-is" as descriptions?
> - 2nd person phrase-style
> - lowercase start
> - no terminating period
> - no shortening

Took the phrases "as-is" from the overview site for the man pages: [Java® Development Kit Version 18 Tool Specifications](https://docs.oracle.com/en/java/javase/18/docs/specs/man/)

-------------

PR: https://git.openjdk.java.net/jdk/pull/8772


More information about the core-libs-dev mailing list