RFR: cover the documentation linking options in release notes [v4]

Iris Clark iris at openjdk.org
Mon Jan 12 17:48:23 UTC 2026


On Fri, 9 Jan 2026 13:25:47 GMT, Roger Calnan <duke at openjdk.org> wrote:

>> added an explanation on the support of JavaDoc like links and the automatic linking of JBS IDs
>
> Roger Calnan has updated the pull request incrementally with one additional commit since the last revision:
> 
>   additional notes

Marked as reviewed by iris (Reviewer).

src/guide/release-notes.md line 86:

> 84:   * Links of the form `[NumberFormat.setStrict]`, `[NumberFormat.setStrict(boolean)]`, `[NumberFormat.setStrict(true)]`, `[ofFileChannel(FileChannel channel, long offset, long length)]` are supported with any of the separators `[.]`, `[#]` and `[::]`.
> 85:   * If a link cannot be found then the string will be rendered as if it had been enclosed in back-ticks and, in the EA release notes only, the string "(link not found)" will be added.
> 86:   * For notes of the type `rn-removed` if a link is not found then it will be looked for in the JavaDoc of the previous release family.

In the Guide's "RN Labels" section, you use "RN-Remove" as the name of the label.  Should the case match?  Also, suggest adding link to the Guides' definition of the label.

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

PR Review: https://git.openjdk.org/guide/pull/167#pullrequestreview-3651957577
PR Review Comment: https://git.openjdk.org/guide/pull/167#discussion_r2683270765


More information about the guide-dev mailing list