doc: escape elements swallowed as HTML in markdown #29374
Conversation
Addresses Markdownlint MD033 issues. Altering changlog should usually be avoided, but they don't render currently.
| `object.passphrase` is optional. Encrypted keys will be decrypted with | ||
| `object.passphrase` if provided, or `options.passphrase` if it is not. | ||
| buffers, or an array of objects in the form | ||
| `{pem: <string|buffer>[, passphrase: <string>]}`. The object form can only |
There was a problem hiding this comment.
Breaking across lines for code element renders OK in GitHub and the rendered HTML, but doesn't in IDEs and is flagged by Markdownlint
| @@ -587,7 +587,7 @@ $ git push upstream master | |||
|
|
|||
| Close the pull request with a "Landed in `<commit hash>`" comment. If | |||
| your pull request shows the purple merged status then you should still | |||
| add the "Landed in <commit hash>..<commit hash>" comment if you added | |||
| add the "Landed in \<commit hash>..\<commit hash>" comment if you added | |||
There was a problem hiding this comment.
This is an improvement for sure (because now it actually renders) so 👍 as-is, but FWIW, it might be good to get the code-display highlighting (like this) from line 588 on this line too or else to remove it from line 588. Either one, but consistent.
There was a problem hiding this comment.
Were you thinking like this:
add the "Landed in `<commit hash>`..`<commit hash>`" comment if you addedor
add the "Landed in `<commit hash>..<commit hash>`" comment if you addedThere was a problem hiding this comment.
Not sure, honestly. Maybe just omitting the backticks entirely?
There was a problem hiding this comment.
Looks like it landed with just the escape. BTW, the backticks in the examples above were just because I codefence'd the line as markdown to show placement of the backticks as where to start/end the code sections that you were talking about
There was a problem hiding this comment.
the backticks in the examples above were just because I codefence'd the line as markdown
Yes, I understand. I was saying that maybe it makes the most sense to eliminate code sections entirely in that bit because <commit hash>..<commit hash> isn't really code. It's unclear whether to also treat Landed in as code, etc. etc. So, just treat it all like a string. But this is all pretty minor stuff and I'm OK with it not being fixed at all or else being fixed in whatever way someone else wants as long as the end result is consistency.
There was a problem hiding this comment.
Sounds good, I'm going to leave it since it's rendering again :)
Trott
added
the
author ready
Addresses Markdownlint MD033 issues. Altering changlog should usually be avoided, but they don't render currently. PR-URL: #29374 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
|
Landed in 61d973a. |
Addresses Markdownlint MD033 issues. Altering changlog should usually be avoided, but they don't render currently. PR-URL: #29374 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Addresses Markdownlint MD033 issues. Altering changlog should usually be avoided, but they don't render currently. PR-URL: #29374 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes