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

[doc] Don't strip markdown headings from HW checklist #3458

Merged
merged 1 commit into from
Sep 17, 2020

Conversation

imphil
Copy link
Contributor

@imphil imphil commented Sep 17, 2020

The checklist template is processed by Mako, which uses ## as template
comment. Use syntax which avoids stripping the headings out.

(The Mako comment behavior cannot really be configured; we could write a
pre-processor which does the escaping, but since we're only having a
single template here and many invocations of Mako in different scripts,
doing that seems fragile. See also
sqlalchemy/mako#268.)

The checklist template is processed by Mako, which uses `##` as template
comment. Use syntax which avoids stripping the headings out.

(The Mako comment behavior cannot really be configured; we could write a
pre-processor which does the escaping, but since we're only having a
single template here and many invocations of Mako in different scripts,
doing that seems fragile. See also
sqlalchemy/mako#268.)

Signed-off-by: Philipp Wagner <[email protected]>
@imphil imphil requested a review from sriyerg as a code owner September 17, 2020 10:56
Copy link
Contributor

@rswarbrick rswarbrick left a comment

Choose a reason for hiding this comment

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

Eugh, I hate templates! Looks good to me.

@imphil imphil merged commit 1d9fc21 into lowRISC:master Sep 17, 2020
@imphil imphil deleted the signoff-template-mako branch September 17, 2020 13:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants