Fix accidental formatting in monospaced text

jkangas commented

2024-09-06 21:47:15 +00:00

Contributor

Some monospaced text in the guide contains double underscores, which results in unintentional italicization (e.g., under Specific Programming Tasks > Processes > Accessing Environment Variables, second bullet point). When this occurs, we can use AsciiDoc's literal monospace syntax to make sure no additional formatting is applied.

Note that some of the changes have no impact on the rendered output, but prevent spurious italicization if another double underscore is added later.

Some monospaced text in the guide contains double underscores, which results in unintentional italicization (e.g., under Specific Programming Tasks > Processes > Accessing Environment Variables, second bullet point). When this occurs, we can use AsciiDoc's [literal monospace](https://docs.asciidoctor.org/asciidoc/latest/text/literal-monospace) syntax to make sure no additional formatting is applied. Note that some of the changes have no impact on the rendered output, but prevent spurious italicization if another double underscore is added later.

ferdnyc commented

2025-03-24 14:19:25 +00:00

Contributor

It's kind of unfortunate how that syntax all shook out. It's also possible to get yourself in trouble when documenting pointers or arithmetic, since asterisks inside backticks will (under the right circumstances) also still trigger bold formatting.

Really, when writing about code in AsciiDoc, it's never wrong and not the worst idea to just always use literal monospace ( `+ ... +` ) syntax, Just In Case.

But that can also feel like overkill, and this PR fixes the necessary/likely trouble spots. +1 from me.

It's kind of unfortunate how that syntax all shook out. It's also possible to get yourself in trouble when documenting pointers or arithmetic, since asterisks inside backticks will (under the right circumstances) _also_ still trigger bold formatting. Really, when writing about code in AsciiDoc, it's never wrong and not the worst idea to just **always** use literal monospace ( <code>`+ ... +`</code> ) syntax, Just In Case. But that can also feel like overkill, and this PR fixes the necessary/likely trouble spots. +1 from me.

pbokoc commented

2025-03-25 14:40:37 +00:00

First-time contributor

Thanks!

pbokoc commented

2025-03-25 14:40:52 +00:00

First-time contributor

Pull-Request has been merged by pbokoc

Rows
Columns

Fix accidental formatting in monospaced text #27