Clarify README for new Rust users. #2286
Merged
Conversation
This file contains hidden or 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
added 2 commits
December 21, 2017 15:21
…he attributes to make it more clear that both should be included.
Contributor
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
As a Rust newbie myself, I had a couple small pitfalls setting up clippy for my existing project.
I wasn't exactly sure how the attribute tabs were working, so I didn't realize that I needed both lines (one for feature(plugin) to be enabled, the other for using the plugin feature to enable clippy through a flag). To clarify, I added ", add these lines", where lines implies that both of these lines should be added to either main.rs or lib.rs. Also I removed the space between the lines to visually group them.
Additionally, I realize that in the README above it says that clippy must be run with the latest nightly, but I missed that on first read through. Would it be useful to add
+nightlyto the commands in the README? It seems better that the commands listed in the README work without any modification.Let me know if I did anything wrong - I'm still pretty new to using Rust! Also thanks for clippy, it is an amazing tool :).