diff --git a/src/content/wiki/diagnostics.mdx b/src/content/wiki/diagnostics.mdx index 282566f..169f155 100644 --- a/src/content/wiki/diagnostics.mdx +++ b/src/content/wiki/diagnostics.mdx @@ -128,6 +128,16 @@ Triggered when the opinionated style checking detects an incorrectly styled line + + +### name-style-check + +**Default File Status:** `"None"` + +Triggered when the opinionated style checking detects an incorrectly named element. + + + ### spell-check @@ -138,6 +148,20 @@ Triggered when a typo is detected in a string. The dictionary can be customized +## conventions + +The conventions group contains diagnostics for maintaining potentially subjective code conventions. + + + +### global-element + +**Default File Status:** `"None"` + +Triggered when an element is not declared `local` to avoid accidentally global elements. + + + ## duplicate The duplicate group contains diagnostics for duplicate indexes and names. @@ -304,6 +328,40 @@ Triggered when there are two [`@param`](/wiki/annotations#param) annotations wit + + +### incomplete-signature-doc + +**Default File Status:** `"None"` + +Triggered when a functions signature is partially documented with [annotations](/wiki/annotations), but the annotations do not cover every element of the signature. +E.g. one of the parameters is not annotated, or the return value is not annotated. + + + + + +### missing-global-doc + +**Default File Status:** `"None"` + +Triggered when a global function is not documented with [annotations](/wiki/annotations), but has parameters (requiring +[`@param`](/wiki/annotations#param) annotations) or a return value (requiring [`@return`](/wiki/annotations#return) annotations). +This ensures that functions are annotated when they are accessible outside of the current module. + + + + + +### missing-local-export-doc + +**Default File Status:** `"None"` + +Triggered when a local function is exported by adding it to the modules' return value, but the functions signature is not documented with [annotations](/wiki/annotations). +This ensures that functions are annotated when they are accessible outside of the current module. + + + ### undefined-doc-class