-
-
Notifications
You must be signed in to change notification settings - Fork 14.8k
Add a tidy check for acceptable rustdoc header #77411
Copy link
Copy link
Open
Labels
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-feature-requestCategory: A feature request, i.e: not implemented / a PR.Category: A feature request, i.e: not implemented / a PR.T-bootstrapRelevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)
Metadata
Metadata
Assignees
Labels
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-feature-requestCategory: A feature request, i.e: not implemented / a PR.Category: A feature request, i.e: not implemented / a PR.T-bootstrapRelevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)
Type
Fields
Give feedbackNo fields configured for issues without a type.
I saw quite a few headers and I think it would be nice for tidy to keep track of them for consistency, maybe even do suggestion. For example,
# Exampleand# Examples, we may accidentally use# Examplesometimes which is not consistent with the rest of the documentation.I also saw that sometimes there are
# Safety:rather than# Safety. Maybe we could suggest them based on edit distance on the possible choices for headers we specified in tidy?CC @rust-lang/docs