Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ENH: Add section "Initializing variables of fixed size array types" #216

Conversation

N-Dekker
Copy link
Contributor

@github-actions github-actions bot added type:Enhancement Improvement of existing methods or implementation area:Appendices Issues affecting the Appendices part language:LaTeX Changes to LaTeX code type:BookStyle Changes to book style files labels Dec 17, 2024
@N-Dekker N-Dekker marked this pull request as draft December 17, 2024 17:05
@N-Dekker N-Dekker force-pushed the InitializingVariablesOfFixedSizeArrayTypes branch from 5e5f2e5 to f10846c Compare December 17, 2024 18:51
@N-Dekker N-Dekker marked this pull request as ready for review December 17, 2024 18:51
@dzenanz dzenanz requested a review from jhlegarreta December 17, 2024 19:11
Copy link
Member

@thewtex thewtex left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@N-Dekker thank you!

@thewtex thewtex merged commit 6371836 into InsightSoftwareConsortium:main Dec 17, 2024
3 checks passed
Copy link
Member

@jhlegarreta jhlegarreta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for my late review. Thanks for doing this @N-Dekker. A few comments inline.

\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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

`{}` 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. To me, the right thing to use here is \code{}.

\end{minted}
\normalsize

\code{Index} and \code{Size} both have a static `Filled(fillValue)` member
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment as above about bacticks.

\end{minted}
\normalsize

For other fixed size array types, the function `itk::MakeFilled<T>(fillValue)`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment as above about backticks.

N-Dekker added a commit to N-Dekker/ITKSoftwareGuide that referenced this pull request Dec 21, 2024
N-Dekker added a commit to N-Dekker/ITKSoftwareGuide that referenced this pull request Dec 21, 2024
Addressed the comments by Jon Haitz Legarreta Gorroño at
InsightSoftwareConsortium#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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:Appendices Issues affecting the Appendices part language:LaTeX Changes to LaTeX code type:BookStyle Changes to book style files type:Enhancement Improvement of existing methods or implementation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants