Add tidy check for missing {# #} tag in rustdoc templates
#130559
Assignees
Labels
A-tidy
Area: The tidy tool
C-enhancement
Category: An issue proposing an enhancement or a PR with one.
T-bootstrap
Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)
T-rustdoc
Relevant to the rustdoc team, which will review and decide on the PR/issue.
Comments
GuillaumeGomez
added
the
T-rustdoc
rustbot
added
the
needs-triage
GuillaumeGomez
removed
the
needs-triage
jieyouxu
added
C-enhancement
rust-timer
added a commit
to rust-lang-ci/rust
that referenced
this issue
Sep 20, 2024
Rollup merge of rust-lang#130585 - GuillaumeGomez:add-rustdoc-template-tidy-check, r=notriddle Add tidy check for rustdoc templates to ensure the whitespace characters are all stripped Fixes rust-lang#130559. I'm planning to send a follow-up in case a tag at the end of a line isn't needed (if the next line starts with a jinja tag for example). r? `@notriddle`
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
To make the generated HTML size smaller, we strip whitespace characters as much as possible in our jinja templates, using
{# #}(jinja comments) to force the trimming between HTML items.However, we often forget to put
{# #}between HTML items (like in #120818 most recently). A tidy check would fix this issue.The text was updated successfully, but these errors were encountered: