RFR: JDK-8292157: Incorrect error: "block element not allowed within inline element <a>"

[Jonathan Gibbons]

On Thu, 1 Jun 2023 13:17:32 GMT, Hannes Wallnöfer <hannesw at openjdk.org> wrote:

>> src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclint/resources/doclint.properties line 80:
>> 
>>> 78: dc.tag.not.allowed = element not allowed in documentation comments: <{0}>
>>> 79: dc.tag.not.allowed.inline.element = block element not allowed within inline element <{1}>: {0}
>>> 80: dc.tag.not.allowed.element.default.style = block element not allowed within element <{1}> with default style: {0}
>> 
>> Is it possible to improve the wording?
>> 
>> As written, it is ambiguous/confusing: it seems like `{0}` is the default style, which I don't think is what you intend.
>> Also, inconsistent pointy brackets `<{1}>` but just `{0}`
>
> Would the following be better?
> 
> 
> block element <{0}> not allowed within element <{1}> with default style
> 
> 
> I found inconsistent use of angle brackets in several other messages in that file. Attempting to fix that causes a lot of breaking doclint tests, not sure if it is worth doing that as part of this change.

That looks good

Optionally, we could file a followup RFE to try and make more resources more stylistically consistent

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

PR Review Comment: https://git.openjdk.org/jdk/pull/13990#discussion_r1219926810