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.

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

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

Open
camelid opened this issue Oct 21, 2020 · 2 comments
Open

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

camelid opened this issue Oct 21, 2020 · 2 comments
Assignees
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools A-meta Area: Issues & PRs about the rust-lang/rust repository itself C-feature-request Category: A feature request, i.e: not implemented / a PR. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) T-compiler Relevant to the compiler team, which will review and decide on the PR/issue.

Comments

@camelid
Copy link
Member

camelid commented Oct 21, 2020

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.

@camelid camelid added A-meta Area: Issues & PRs about the rust-lang/rust repository itself C-feature-request Category: A feature request, i.e: not implemented / a PR. A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. labels Oct 21, 2020
@jyn514
Copy link
Member

jyn514 commented Oct 21, 2020

This would fit as a new check in tidy I think. Not sure if it already parses feature gates, I know it parses error codes though.

@camelid camelid added the T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) label Oct 21, 2020
@camelid camelid self-assigned this Oct 24, 2020
@albertlarsan68
Copy link
Member

cc #103548

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools A-meta Area: Issues & PRs about the rust-lang/rust repository itself C-feature-request Category: A feature request, i.e: not implemented / a PR. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) T-compiler Relevant to the compiler team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

3 participants