-
-
Notifications
You must be signed in to change notification settings - Fork 14.8k
Add automated tool to ensure new feature gates are documented #78211
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 toolsA-metaArea: Issues & PRs about the rust-lang/rust repository itselfArea: Issues & PRs about the rust-lang/rust repository itselfC-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)T-compilerRelevant to the compiler team, which will review and decide on the PR/issue.Relevant to the compiler team, which will review and decide on the PR/issue.
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 toolsA-metaArea: Issues & PRs about the rust-lang/rust repository itselfArea: Issues & PRs about the rust-lang/rust repository itselfC-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)T-compilerRelevant to the compiler team, which will review and decide on the PR/issue.Relevant to the compiler team, which will review and decide on the PR/issue.
Type
Fields
Give feedbackNo fields configured for issues without a type.
This would be part of a larger effort to automate documentation updates. The
issue is that updates to the compiler may require updates to documentation, but
it's not as simple as just updating a doc comment; you may need to:
The goal for this first issue is to just add a check that would be run in CI to
ensure all feature gates have documentation in the unstable book. Quoting from
@jyn514 on Zulip:
See the relevant discussion here on Zulip.