Clarify allow/warn/deny documentation. Remove enable/disable. #6270
Conversation
Disable and enable when not specifically explained were not clear to me as an English language speaker, but I was able to figure it out fairly easily due to the examples having A/W, which I assumed meant `allow` and `warn`. I removed both words to be sure it was clear as well as extending the note on what deny means. It now includes a statement on exactly what each word means.
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @flip1995 (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. Please see the contribution instructions for more information. |
rust-highfive
added
the
S-waiting-on-review
README.md
Outdated
| Note: `allow` in this case means to "allow your code to have the lint without | ||
| warning". `deny` means "produce an error if your code has the lint". `warn` | ||
| means "produce a warning, but don't produce an error due to this lint". An | ||
| error causes clippy to exit with an error code, so is useful in scripts like | ||
| CI/CD. |
There was a problem hiding this comment.
I don't like the wording here. Code cannot "have a lint". But a lint triggers for code. Also just because something is marked with warn, doesn't mean the lint will trigger.
allowmeans to suppress the lint for your code. Withwarnthe lint will only emit a warning, while withdenythe lint will emit an error, when triggering for your code. An error causes clippy to exit with an error code, so is useful in scripts like CI/CD.
There was a problem hiding this comment.
Thanks for taking a look!
I like your reword, I was trying to figure out the right wording but couldn't come up with anything better than "having lint on a shirt" terminology. I've pushed the change!
|
@bors r+ Thanks! |
|
📌 Commit cf2043d has been approved by |
|
☀️ Test successful - checks-action_dev_test, checks-action_remark_test, checks-action_test |
|
I think this should count for Hacktoberfest. Does it need a tag or anything to get counted? |
|
Nope, it should appear in your hacktoberfest profile with the "In review" label. Note that "in review" does not mean, in review by us, but by the hacktoberfest folks. |
|
Apparently it doesn't count when you do the work:
|
|
Oh, sorry about that. I got the information, that it will also count if accepted later on. |
|
Yep! Not your fault. I didn't know that either!
I'm just happy the change got in. I was learning Rust before hacktoberfest
and will be learning it after.
…On Sun, Nov 8, 2020, 8:46 AM Philipp Krones ***@***.***> wrote:
Oh, sorry about that. I got the information, that it will also count if
accepted later on. hacktoberfest was a bit too much for the Clippy team
this year, because of unforeseeable circumstances.
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#6270 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAB4UKKIT42YST5VLTMI7XTSO2VLZANCNFSM4TFHLAPQ>
.
|
Disable and enable when not specifically explained were not clear to me
as an English language speaker, but I was able to figure it out fairly
easily due to the examples having A/W, which I assumed meant
allowandwarn. I removed both words to be sure it was clear as well asextending the note on what deny means. It now includes a statement on
exactly what each word means.
Documentation only update.
Please keep the line below
changelog: none