This repository has been archived by the owner on Nov 24, 2023. It is now read-only.
README update aiming to clarify things for less experienced rustaceans #222
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
weihanglo
reviewed
Oct 15, 2023
| - `rustfix`, a library for consuming and applying suggestions in the format that `rustc` outputs | ||
| - and `cargo-fix`, a binary that works as cargo subcommand and that end users will use to fix their code. | ||
| - `rustfix`, a library for consuming and applying suggestions in the format that `rustc` outputs (this crate) | ||
| - `cargo-fix`, a binary that works as cargo subcommand and that end users will use to fix their code (maintained in the [cargo](https://github.com/rust-lang/cargo/blob/master/src/cargo/ops/fix.rs) repo). |
There was a problem hiding this comment.
nit: I may link to https://github.com/rust-lang/cargo/blob/master/src/bin/cargo/commands/fix.rs, which is more like the entry of the entire "binary" part of cargo-fix.
Co-authored-by: Weihang Lo <weihanglo@users.noreply.github.com>
Co-authored-by: Weihang Lo <weihanglo@users.noreply.github.com>
3tilley
added a commit
to 3tilley/rustfix
that referenced
this pull request
Oct 17, 2023
This was referenced Oct 17, 2023
Closed
Manishearth
added a commit
that referenced
this pull request
Oct 17, 2023
Apply PR suggestion from #222
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello,
Following on from #221 I thought I would have a go at improving the README a little. I've looked at this crate several times in the past thinking it did something different to what it actually did!
Please feel free to correct anything I've put that isn't correct. The goal is to let people know what the library does, as well as directing them that what they're looking for probably isn't here.
Max