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

Document tidy and bootstrap #106803

Closed
albertlarsan68 opened this issue Jan 13, 2023 · 4 comments
Closed

Document tidy and bootstrap #106803

albertlarsan68 opened this issue Jan 13, 2023 · 4 comments
Assignees
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)

Comments

@albertlarsan68
Copy link
Member

albertlarsan68 commented Jan 13, 2023

Location

Most of the tidy tool (located at src/tools/tidy), and most of the bootstrap source (located at src/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.

@albertlarsan68 albertlarsan68 added the A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools label Jan 13, 2023
@albertlarsan68
Copy link
Member Author

@rustbot label +A-bootstrap

@rustbot rustbot added the T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) label Jan 13, 2023
@albertlarsan68 albertlarsan68 changed the title Document tidy Document tidy and bootstrap Jan 13, 2023
@Teapot4195
Copy link
Contributor

@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)?

@jyn514
Copy link
Member

jyn514 commented Mar 9, 2023

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.

I think we can start doing that even before writing manual documentation, the autogenerated docs from rustdoc are already quite helpful.

@Teapot4195
Copy link
Contributor

Sounds good, I'll open a pr for that.

matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Mar 11, 2023
…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?
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Mar 12, 2023
…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?
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Mar 12, 2023
…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?
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 T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)
Projects
None yet
Development

No branches or pull requests

5 participants