Skip to content

Commit

Permalink
COMP: Replace backticks with \code{} in Initialization and Assignment
Browse files Browse the repository at this point in the history
Addressed the comments by Jon Haitz Legarreta Gorroño at
#216 (review)

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.
  • Loading branch information
N-Dekker committed Dec 21, 2024
1 parent 6371836 commit 5246e64
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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<T>(fillValue)`
For other fixed size array types, the function \code{itk::MakeFilled<T>(fillValue)}
is preferable, when the array should initially be filled with a value that may
be non-zero. For example:
Expand Down

0 comments on commit 5246e64

Please sign in to comment.