Skip to content

Add automated tool to ensure new feature gates are documented #78211

Open
@camelid

Description

@camelid

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:

  • Update the rustc-dev-guide
  • Update the unstable book
  • Update the reference
  • etc.

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:

I think we should nibble at this a little at a time instead of trying to get a fully general solution, because the fully-general solution isn't possible without you specifying the dependencies yourself and I really hate that in build systems

See the relevant discussion here on Zulip.

Metadata

Metadata

Assignees

Labels

A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsA-metaArea: Issues & PRs about the rust-lang/rust repository itselfC-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)T-compilerRelevant to the compiler team, which will review and decide on the PR/issue.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions