Skip to content

Add a tidy check for acceptable rustdoc header #77411

@pickfire

Description

@pickfire

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, # Example and # Examples, we may accidentally use # Example sometimes 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

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-docsArea: 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.T-bootstrapRelevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions