From archie.cobbs at gmail.com Thu Apr 13 13:31:05 2023 From: archie.cobbs at gmail.com (Archie Cobbs) Date: Thu, 13 Apr 2023 08:31:05 -0500 Subject: Release notes formatting discrepancy Message-ID: Not sure where to send this question, so my apologies for any misdirection... There seems to be some discrepancy in the syntax specification for release notes, at least with regards to backslashes. Take JDK-8304995 for example. The end result is supposed to contain an example that looks like this: public class Test { interface Cafe\u0301 { } interface Caf\u00e9 { } } Note the single backslashes in there. The corresponding JIRA issue description contains only single backslashes. The JDK developer's guide says: "While the markdown won?t be rendered in JBS, you can use dingus to see what the release note will look like." When the JIRA description text is copied and pasted into dingus (or the other dingus ) the single blackslashes appear correctly. However, in the current release notes the backslashes are missing. It appears that the statement "you can use dingus to see what the release note will look like" is not really correct. Where is the breakdown here? Thanks, -Archie -- Archie L. Cobbs -------------- next part -------------- An HTML attachment was scrubbed... URL: From jesper.wilhelmsson at oracle.com Thu Apr 13 15:05:08 2023 From: jesper.wilhelmsson at oracle.com (Jesper Wilhelmsson) Date: Thu, 13 Apr 2023 15:05:08 +0000 Subject: Release notes formatting discrepancy In-Reply-To: References: Message-ID: <2C7B3CF1-2E9C-4C6A-9310-2C1EB0C7446C@oracle.com> Hi Archie, Moving to guide-dev which seems more appropriate for this discussion. Also including Marc who has more experience working with release notes. /Jesper > On 13 Apr 2023, at 15:31, Archie Cobbs wrote: > > Not sure where to send this question, so my apologies for any misdirection... > > There seems to be some discrepancy in the syntax specification for release notes, at least with regards to backslashes. > > Take JDK-8304995 for example. The end result is supposed to contain an example that looks like this: > > public class Test { > interface Cafe\u0301 { > } > interface Caf\u00e9 { > } > } > > Note the single backslashes in there. > > The corresponding JIRA issue description contains only single backslashes. > > The JDK developer's guide says: "While the markdown won?t be rendered in JBS, you can use dingus to see what the release note will look like." > > When the JIRA description text is copied and pasted into dingus (or the other dingus ) the single blackslashes appear correctly. > > However, in the current release notes the backslashes are missing. > > It appears that the statement "you can use dingus to see what the release note will look like" is not really correct. > > Where is the breakdown here? > > Thanks, > -Archie > > -- > Archie L. Cobbs -------------- next part -------------- An HTML attachment was scrubbed... URL: -------------- next part -------------- A non-text attachment was scrubbed... Name: signature.asc Type: application/pgp-signature Size: 833 bytes Desc: Message signed with OpenPGP URL: