Skip to content

Document tidy and bootstrap #106803

@albertlarsan68

Description

@albertlarsan68
Member

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.

Activity

added
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and tools
on Jan 13, 2023
albertlarsan68

albertlarsan68 commented on Jan 13, 2023

@albertlarsan68
MemberAuthor

@rustbot label +A-bootstrap

added
T-bootstrapRelevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)
on Jan 13, 2023
changed the title [-]Document tidy[/-] [+]Document tidy and bootstrap[/+] on Jan 13, 2023
Teapot4195

Teapot4195 commented on Mar 7, 2023

@Teapot4195
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

jyn514 commented on Mar 9, 2023

@jyn514
Member

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

Teapot4195 commented on Mar 9, 2023

@Teapot4195
Contributor

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

added 3 commits that reference this issue on Mar 11, 2023
b2384b7
05ef0bd
0b0f334
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

A-docsArea: 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)

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

    Development

    No branches or pull requests

      Participants

      @jyn514@onur-ozkan@rustbot@albertlarsan68@Teapot4195

      Issue actions

        Document tidy and bootstrap · Issue #106803 · rust-lang/rust