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.

Sign up for GitHub

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

Jump to bottom

Add tidy check for missing {# #} tag in rustdoc templates #130559

Open
GuillaumeGomez opened this issue Sep 19, 2024 · 0 comments · May be fixed by #130585
Open

Add tidy check for missing {# #} tag in rustdoc templates #130559

GuillaumeGomez opened this issue Sep 19, 2024 · 0 comments · May be fixed by #130585
Assignees
@GuillaumeGomez
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
Copy link
Member

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.
@GuillaumeGomez GuillaumeGomez added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Sep 19, 2024
@GuillaumeGomez GuillaumeGomez self-assigned this Sep 19, 2024
@rustbot rustbot added the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Sep 19, 2024
@GuillaumeGomez GuillaumeGomez removed the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Sep 19, 2024
@jieyouxu jieyouxu added 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) A-tidy Area: the tidy tool labels Sep 19, 2024
@GuillaumeGomez GuillaumeGomez linked a pull request Sep 19, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@GuillaumeGomez GuillaumeGomez

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.
Projects
None yet
Milestone
No milestone
3 participants
@GuillaumeGomez @jieyouxu @rustbot