Skip to content

Commit 06c1d98

Browse files
Apply suggestions from code review
Co-authored-by: Travis Cross <tc@traviscross.com>
1 parent c17f60c commit 06c1d98

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/authoring.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -78,12 +78,12 @@ In the HTML, the rules are clickable just like headers.
7878
When assigning rules to new paragraphs, or when modifying rule names, use the following guidelines:
7979
1. A rule applies to one core idea, which should be easily determined when reading the paragraph it is applied to,
8080
2. Other than the "intro" paragraph, purely explanatory, expository, or exemplary content does not need a rule. If the expository paragraph isn't directly related to the previous, separate it with a hard (rendered) line break
81-
3. Rust Code examples and tests do not need their own rules
81+
3. Rust code examples and tests do not need their own rules
8282
4. Notes do not need rules. For other admonition types, use the following guidelines:
8383
* Warning: Omit the rule if and only if the warning follows from the previous paragraph.
84-
* Target Specific Behaviour: Always include the rule
85-
* Edition Differences: Always include the rule
86-
* Version History: Omit the rule if the present behaviour is explained in the immediately preceeding rule.
84+
* Target specific behaviour: Always include the rule
85+
* Edition differences: Always include the rule
86+
* Version history: Omit the rule if the present behaviour is explained in the immediately preceeding rule.
8787
4. The following keywords should be used to identify paragraphs when unambiguous:
8888
* `intro`: The beginning paragraph of each section - should explain the construct being defined overall.
8989
* `syntax`: Syntax definitions or explanations when BNF syntax definitions are not used
@@ -95,7 +95,7 @@ When assigning rules to new paragraphs, or when modifying rule names, use the fo
9595
* `preconditions`: Conditions which must be satisfied for the evaluation of the construct to be well-defined
9696
* `namespace`: For items only, specifies the namespace(s) the item introduces a name in. May also be used elsewhere when defining a namespace (e.g. `r[attribute.diagnostic.namespace]`)
9797
5. When a rule doesn't fall under the above keywords. or for section rule ids, name the subrule as follows:
98-
* If the rule is naming a specific Rust language construct (IE. an attribute, standard library type/function, or keyword-introduced concept), use the construct as named in the language, appropriately case-adjusted (but do not replace `_`s with `-`s)
98+
* If the rule is naming a specific Rust language construct (e.g. an attribute, standard library type/function, or keyword-introduced concept), use the construct as named in the language, appropriately case-adjusted (but do not replace `_`s with `-`s)
9999
* Other than rust language concepts with `_`s in the name, use `-` characters to separate words within a "subrule"
100100
* Whenever possible, do not repeat previous components of the rule
101101
* Prefer using singular forms of words over plural unless the rule applies to a list or the construct is named as plural in the language (e.g. `r[attribute.diagnostic.lint.group])

0 commit comments

Comments
 (0)