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.

Sign up for GitHub

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

Jump to bottom

rustfix: Add library documentation #13032

Closed
ehuss opened this issue Nov 22, 2023 · 2 comments · Fixed by #13048
Closed

rustfix: Add library documentation #13032

ehuss opened this issue Nov 22, 2023 · 2 comments · Fixed by #13048
Assignees
@weihanglo
Labels
A-cargo-api Area: cargo-the-library API and internal code issues A-documenting-cargo-itself Area: Cargo's documentation C-enhancement Category: enhancement Command-fix S-accepted Status: Issue or feature is accepted, and has a team member available to help mentor or review

Comments

@ehuss
Copy link
Contributor

ehuss commented Nov 22, 2023 •
edited by rustbot
Loading

The rustfix library at https://github.com/rust-lang/cargo/tree/master/crates/rustfix/src has very little API or internal documentation. It would be nice if someone could go through and document things and tidy up any existing documentation.
@ehuss ehuss added C-enhancement Category: enhancement A-cargo-api Area: cargo-the-library API and internal code issues S-accepted Status: Issue or feature is accepted, and has a team member available to help mentor or review Command-fix labels Nov 22, 2023
@weihanglo
Copy link
Member

ehuss if you're not working on it, I can take a stab.

@rustbot claims

@weihanglo
Copy link
Member

@rustbot claim

@weihanglo weihanglo added the A-documenting-cargo-itself Area: Cargo's documentation label Nov 22, 2023
@weihanglo weihanglo mentioned this issue Nov 25, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@weihanglo weihanglo

Labels
A-cargo-api Area: cargo-the-library API and internal code issues A-documenting-cargo-itself Area: Cargo's documentation C-enhancement Category: enhancement Command-fix S-accepted Status: Issue or feature is accepted, and has a team member available to help mentor or review
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: add doc comments for rustfix weihanglo/cargo
2 participants
@ehuss @weihanglo