From 5246e64e207c9f28a75ae624bd0301877d606c97 Mon Sep 17 00:00:00 2001 From: Niels Dekker Date: Sat, 21 Dec 2024 11:32:52 +0100 Subject: [PATCH] COMP: Replace backticks with `\code{}` in Initialization and Assignment MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Addressed the comments by Jon Haitz Legarreta Gorroño at https://github.com/InsightSoftwareConsortium/ITKSoftwareGuide/pull/216#pullrequestreview-2511975124 Specifically: > `{}` will not highlight the content in LaTeX as you would expect in Markdown: > LaTex uses double backticks at the beginning/upright ticks at the end for > ticks, simple backticks will render as opening simple ticks both at the > beginning/end. --- SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex b/SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex index f5d865a3..e832ed4e 100644 --- a/SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex +++ b/SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex @@ -1664,7 +1664,7 @@ \subsection{Initializing variables of fixed size array types} \code{Index}, \code{Size}, \code{FixedArray}, \code{Point}, and \code{Vector}. A variable of such a fixed size array type can be zero-initialized by an empty -initializer list, `{}`. This is usually the preferred way to initialize the +initializer list, \code{{}}. This is usually the preferred way to initialize the variable, when it should initially be filled with zeroes. For example: \small @@ -1677,7 +1677,7 @@ \subsection{Initializing variables of fixed size array types} \end{minted} \normalsize -\code{Index} and \code{Size} both have a static `Filled(fillValue)` member +\code{Index} and \code{Size} both have a static \code{Filled(fillValue)} member function, to allow creating a variable that is filled with an arbitrary value. For these types, this is usually the preferred way to initialize the variable, when it should initially be filled with a value that may be non-zero. For @@ -1693,7 +1693,7 @@ \subsection{Initializing variables of fixed size array types} \end{minted} \normalsize -For other fixed size array types, the function `itk::MakeFilled(fillValue)` +For other fixed size array types, the function \code{itk::MakeFilled(fillValue)} is preferable, when the array should initially be filled with a value that may be non-zero. For example: