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

docs: 0344-conventions-galore.md should use _ #3619

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+2 −2
Open

docs: 0344-conventions-galore.md should use _ #3619

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions text/0344-conventions-galore.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ seem like a minor concern, when we hit 1.0 the lint names will be locked down,
so it's worth trying to clean them up now.

The basic rule is: the lint name should make sense when read as "allow
*lint-name*" or "allow *lint-name* items". For example, "allow
*lint_name*" or "allow *lint_name* items". For example, "allow
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are just inline examples, but they should follow the _ convention given in the rest of this section.

`deprecated` items" and "allow `dead_code`" makes sense, while "allow
`unsafe_block`" is ungrammatical (should be plural).

Expand All @@ -225,7 +225,7 @@ Specifically, this RFC proposes that:

* Lints that apply to arbitrary items (like the stability lints) should just
mention what they check for: use `deprecated` rather than `deprecated_items`.
This keeps lint names short. (Again, think "allow *lint-name* items".)
This keeps lint names short. (Again, think "allow *lint_name* items".)

* If a lint applies to a specific grammatical class, mention that class and use
the plural form: use `unused_variables` rather than `unused_variable`.
Expand Down