-
Notifications
You must be signed in to change notification settings - Fork 13.7k
Closed
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 toolsT-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)
Description
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.
jyn514
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 toolsT-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)
Type
Projects
Milestone
Relationships
Development
Select code repository
Activity
albertlarsan68 commentedon Jan 13, 2023
@rustbot label +A-bootstrap
[-]Document tidy[/-][+]Document tidy and bootstrap[/+]Teapot4195 commentedon Mar 7, 2023
@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 commentedon Mar 9, 2023
I think we can start doing that even before writing manual documentation, the autogenerated docs from rustdoc are already quite helpful.
Teapot4195 commentedon Mar 9, 2023
Sounds good, I'll open a pr for that.
Rollup merge of rust-lang#108984 - Teapot4195:issue-106803-fix, r=ozk…
Rollup merge of rust-lang#108984 - Teapot4195:issue-106803-fix, r=ozk…
Rollup merge of rust-lang#108984 - Teapot4195:issue-106803-fix, r=ozk…