On Tue, 22 Nov 2022 18:17:28 GMT, Roger Riggs <rri...@openjdk.org> wrote:
>> Jim Laskey has updated the pull request incrementally with one additional
>> commit since the last revision:
>>
>> Seal Digits
>
> src/java.base/share/classes/java/lang/template/package-info.java line 57:
>
>> 55: *{@link java.lang.template.StringTemplate}. The end result of the
>> process template
>> 56: * expression is the value that is produced by invoking the processor's
>> 57: *{@link java.lang.template.ValidatingProcessor#process(StringTemplate)}
>
> I would reduce the use of "proper", it should be sufficient to describe them
> without the qualifier.
> The single use of "improper" is fine to warn of compilation errors.
>
> Also, add a space between "*" and "{".
Changing.
> src/java.base/share/classes/java/lang/template/package-info.java line 61:
>
>> 59: * improper processor arguments result in compilation errors.
>> 60: * <p>
>> 61: * In the example, {@code STR."The result of adding \{x} and \{y} is \{x
>> + y}."},
>
> Maybe avoid the repetition of the example.
> Suggestion:
>
> * In the example above,
Changing.
> src/java.base/share/classes/java/lang/template/package-info.java line 76:
>
>> 74: * String literals and text blocks can be used as proper processor
>> arguments as
>> 75: * well. This is automatically facilitated by the Java compiler
>> converted the
>> 76: * strings to {@link java.lang.template.StringTemplate StringTemplate}
>> using the
>
> Suggestion:
>
> * well. This is automatically facilitated by the Java compiler converting the
> * strings to {@link java.lang.template.StringTemplate StringTemplate} using
> the
Changing.
> src/java.base/share/classes/java/lang/template/package-info.java line 79:
>
>> 77: * {@link java.lang.template.StringTemplate#of(String)} method.
>> 78: * <p>
>> 79: * Users can create their own template processors by implementing either
>
> Suggestion:
>
> * Users can create their own template processors by implementing one of
Changing.
> src/java.base/share/classes/java/lang/template/package-info.java line 83:
>
>> 81: * {@link java.lang.template.TemplateProcessor} or
>> 82: * {@link java.lang.template.StringProcessor} interfaces.
>> 83: * See {@link java.lang.template.ValidatingProcessor} for examples and
>> details.
>
> I would give the reader a firm what to read next suggestion.
> It may be useful to mention and link to the `FMT` processor as a way to
> control the formatting of the values.
> Suggestion:
>
> * For more examples and details see {@link
> java.lang.template.StringTemplate} and
> * {@link java.lang.template.ValidatingProcessor}.
Changing.
-------------
PR: https://git.openjdk.org/jdk/pull/10889
