JDK-8292157: Incorrect error: "block element not allowed within inline element <a>" #13990
Conversation
|
👋 Welcome back hannesw! A progress list of the required criteria for merging this PR into |
openjdk
bot
added
javadoc
Webrevs
|
| @@ -77,8 +77,8 @@ dc.tag.nested.tag=nested tag: {0} | |||
| dc.tag.not.allowed.here = tag not allowed here: <{0}> | |||
| dc.tag.not.allowed = element not allowed in documentation comments: <{0}> | |||
| dc.tag.not.allowed.inline.element = block element not allowed within inline element <{1}>: {0} | |||
| dc.tag.not.allowed.inline.tag = block element not allowed within @{1}: {0} | |||
| dc.tag.not.allowed.inline.other = block element not allowed here: {0} | |||
| dc.tag.not.allowed.element.default.style = block element not allowed within element <{1}> with default style: {0} | |||
There was a problem hiding this comment.
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}
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
That looks good
Optionally, we could file a followup RFE to try and make more resources more stylistically consistent
There was a problem hiding this comment.
I changed the messages to the new format.
|
@hns This change now passes all automated pre-integration checks. ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details. After integration, the commit message for the final commit will be: You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed. At the time when this comment was updated there had been 366 new commits pushed to the
As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details. ➡️ To integrate this PR with the above commit message to the |
|
/integrate |
|
Going to push as commit 0a4f9ad.
Your commit was automatically rebased without conflicts. |
openjdk
bot
removed
ready
Please review a change to downgrade from error to warning if the label of a
<a>element or reference tag contains an HTML block element. Before HTML 5, elements were clearly divided into block and inline elements, and the latter were not allowed to contain the former.With HTML5, the division between block and inline elements is delegated to CSS, and although elements have default styles, styles can be freely customized by the author. This applies especially true for the
<a>element which is commonly used both with inline and block layout. That was the rationale for downgrading from error to warning for the<a>element only. See the JBS issue comments for details and references.The error message for the warning was enhanced to refer to the default style for the
<a>element.Progress
Issue
"4")Reviewers
Reviewing
Using
gitCheckout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/13990/head:pull/13990$ git checkout pull/13990Update a local copy of the PR:
$ git checkout pull/13990$ git pull https://git.openjdk.org/jdk.git pull/13990/headUsing Skara CLI tools
Checkout this PR locally:
$ git pr checkout 13990View PR using the GUI difftool:
$ git pr show -t 13990Using diff file
Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/13990.diff
Webrev
Link to Webrev Comment