Skip to content

Commit d032fa8

Browse files
committed
Document naming conventions for admonition identifiers
1 parent d628425 commit d032fa8

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/authoring.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,10 @@ When assigning rules to new paragraphs, or when modifying rule names, use the fo
9494
* Other than rust language concepts with `_`s in the name, use `-` characters to separate words within a "subrule"
9595
* Whenever possible, do not repeat previous components of the rule
9696
* 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])
97-
* Whenever possible, don't use a name that conflicts with one of the above keywords, even if this violates the first bullet.
97+
* Edition differences admonitions should typically be named by the edition referenced directly by the rule. If multiple editions are named, use the one for which the behaviour is defined by the admonition, and not by a previous paragraph
98+
* Target Specific admonitions should typically be named by the least specific target property to which they apply (e.g. if a rule affects all x86 cpus, the rule name should include `x86` rather than separately listing `i586`, `i686` and `x86_64`, and if a rule applies to all ELF platforms, it should be named `elf` rather than listing every ELF os)
9899
* Use an appropriately discriptive, but short, name if the language does not provide one.
100+
99101

100102
### Standard library links
101103

0 commit comments

Comments
 (0)