-
Notifications
You must be signed in to change notification settings - Fork 12.8k
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
Document tidy and bootstrap #106803
Comments
@rustbot label +A-bootstrap |
@rustbot claim i've noticed most of tidy already has crate level docs, so my guess is that we should document the functions in the crates (found in tidy and bootstrap)? |
I think we can start doing that even before writing manual documentation, the autogenerated docs from rustdoc are already quite helpful. |
Sounds good, I'll open a pr for that. |
…anonur bootstrap: document tidy Enable documentation of tidy, as suggested in rust-lang#106803. Jyn mentioned they should probably be added to `doc.rust-lang.org`, how should that be done?
…anonur bootstrap: document tidy Enable documentation of tidy, as suggested in rust-lang#106803. Jyn mentioned they should probably be added to `doc.rust-lang.org`, how should that be done?
…anonur bootstrap: document tidy Enable documentation of tidy, as suggested in rust-lang#106803. Jyn mentioned they should probably be added to `doc.rust-lang.org`, how should that be done?
Location
Most of the
tidy
tool (located atsrc/tools/tidy
), and most of thebootstrap
source (located atsrc/bootstrap
)Summary
Actually, adding a new
tidy
check means digging through existing code to find how it works.I propose adding doc-comments to the
tidy
items, in order to get the new contributors to understand it better.We should also do it for the
bootstrap
crate, since it is a base building block of Rust, but currently is very opaque in how it works.Future possibilities
We can also post the rendered docs to
doc.rust-lang.org
, but this is a later step that is being made possible by documenting the current items.The text was updated successfully, but these errors were encountered: