defensive-coding-guide

#27 Fix accidental formatting in monospaced text
Merged by pbokoc. Opened by jkangas.
jkangas/defensive-coding-guide literal-monospace-conversion  into  master

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.

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.

Thanks!

Pull-Request has been merged by pbokoc
Metadata
None
No Tags
Changes Summary 3
+2 -2
file changed
modules/ROOT/pages/programming-languages/C.adoc
+1 -1
file changed
modules/ROOT/pages/programming-languages/Java.adoc
+3 -3
file changed
modules/ROOT/pages/tasks/Tasks-Processes.adoc
Static archive. pagure.io was sunset in 2026; this is a read-only snapshot.
Red Hat Logo

Fedora is sponsored by Red Hat. Learn more about the relationship between Red Hat and Fedora »

© Red Hat, Inc. and others.