Skip to content

Commit

Permalink
Document naming conventions for admonition identifiers
Browse files Browse the repository at this point in the history
  • Loading branch information
chorman0773 committed Sep 26, 2024
1 parent d628425 commit d032fa8
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/authoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,10 @@ When assigning rules to new paragraphs, or when modifying rule names, use the fo
* Other than rust language concepts with `_`s in the name, use `-` characters to separate words within a "subrule"
* Whenever possible, do not repeat previous components of the rule
* 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])
* Whenever possible, don't use a name that conflicts with one of the above keywords, even if this violates the first bullet.
* 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
* 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)
* Use an appropriately discriptive, but short, name if the language does not provide one.


### Standard library links

Expand Down

0 comments on commit d032fa8

Please sign in to comment.