RFR: 8354320: Changes to jpackage.md cause pandoc warning
Magnus Ihse Bursie
ihse at openjdk.org
Fri Apr 11 10:21:41 UTC 2025
On Thu, 10 Apr 2025 21:50:10 GMT, Alexey Semenyuk <asemenyuk at openjdk.org> wrote:
> Escape the dollar sign.
I'm not entirely sure this is a good solution. Yes, it makes pandoc happy and removes the warning, but this is using a pandoc extension and not standard markdown. A standard markdown renderer will show this as the literal `$`, and not just a `$` which is intended.
I will repeat my suggestion to put the special characters inside backticks. Not only will it prevent pandoc from trying to do any expansion, it will also follow a general practice of formatting code where literals the user should type is in monotype. So I think it would kill two birds with one stone.
-------------
PR Comment: https://git.openjdk.org/jdk/pull/24585#issuecomment-2796488922
More information about the core-libs-dev
mailing list