mirror of
https://github.com/microsoft/BCQuality.git
synced 2026-10-06 07:06:54 +01:00
Fix remaining READ-convention sample links across this PR's 18 articles
The same plain-backtick "See sample: \`x.good.al\`." form fixed on al-methods-limited-during-write-transactions (PR #161) turned up repo-wide on 15 more of this PR's articles - Knowledge-Retrieval.ps1 requires the markdown-link form to associate a sample with its article. All 16 fixed; the four local validators (frontmatter, knowledge-index, knowledge-retrieval, review-fixtures, skill-index) pass.
This commit is contained in:
parent
faa0bceb86
commit
b983a6da57
16 changed files with 32 additions and 32 deletions
|
|
@ -19,10 +19,10 @@ When a variable or field represents a fixed set of named, mutually exclusive sta
|
|||
|
||||
Declare an `Enum` with named values and branch on the enum value, not a raw number.
|
||||
|
||||
See sample: `fixed-choice-set-must-use-enum-not-integer.good.al`.
|
||||
See sample: [`fixed-choice-set-must-use-enum-not-integer.good.al`](fixed-choice-set-must-use-enum-not-integer.good.al).
|
||||
|
||||
## Anti Pattern
|
||||
|
||||
Using a plain `Integer` field with the meaning of each value tracked only in a comment pushes the documentation of the states into something the compiler cannot check and a future maintainer cannot rely on.
|
||||
|
||||
See sample: `fixed-choice-set-must-use-enum-not-integer.bad.al`.
|
||||
See sample: [`fixed-choice-set-must-use-enum-not-integer.bad.al`](fixed-choice-set-must-use-enum-not-integer.bad.al).
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue