Skip to content

Commit 14fa2ff

Browse files
add: documentation for some missing diagnostics (#37)
1 parent c6c1e08 commit 14fa2ff

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

src/content/wiki/diagnostics.mdx

+58
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,16 @@ Triggered when the opinionated style checking detects an incorrectly styled line
128128

129129
</Diagnostic>
130130

131+
<Diagnostic level="Warning">
132+
<Fragment slot="name">
133+
### name-style-check
134+
</Fragment>
135+
**Default File Status:** `"None"`
136+
137+
Triggered when the opinionated style checking detects an incorrectly named element.
138+
139+
</Diagnostic>
140+
131141
<Diagnostic level="Information">
132142
<Fragment slot="name">
133143
### spell-check
@@ -138,6 +148,20 @@ Triggered when a typo is detected in a string. The dictionary can be customized
138148

139149
</Diagnostic>
140150

151+
## conventions
152+
153+
The conventions group contains diagnostics for maintaining potentially subjective code conventions.
154+
155+
<Diagnostic level="Warning">
156+
<Fragment slot="name">
157+
### global-element
158+
</Fragment>
159+
**Default File Status:** `"None"`
160+
161+
Triggered when an element is not declared `local` to avoid accidentally global elements.
162+
163+
</Diagnostic>
164+
141165
## duplicate
142166

143167
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
304328

305329
</Diagnostic>
306330

331+
<Diagnostic level="Warning">
332+
<Fragment slot="name">
333+
### incomplete-signature-doc
334+
</Fragment>
335+
**Default File Status:** `"None"`
336+
337+
Triggered when a functions signature is partially documented with [annotations](/wiki/annotations), but the annotations do not cover every element of the signature.
338+
E.g. one of the parameters is not annotated, or the return value is not annotated.
339+
340+
</Diagnostic>
341+
342+
<Diagnostic level="Warning">
343+
<Fragment slot="name">
344+
### missing-global-doc
345+
</Fragment>
346+
**Default File Status:** `"None"`
347+
348+
Triggered when a global function is not documented with [annotations](/wiki/annotations), but has parameters (requiring
349+
[`@param`](/wiki/annotations#param) annotations) or a return value (requiring [`@return`](/wiki/annotations#return) annotations).
350+
This ensures that functions are annotated when they are accessible outside of the current module.
351+
352+
</Diagnostic>
353+
354+
<Diagnostic level="Warning">
355+
<Fragment slot="name">
356+
### missing-local-export-doc
357+
</Fragment>
358+
**Default File Status:** `"None"`
359+
360+
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).
361+
This ensures that functions are annotated when they are accessible outside of the current module.
362+
363+
</Diagnostic>
364+
307365
<Diagnostic level="Warning">
308366
<Fragment slot="name">
309367
### undefined-doc-class

0 commit comments

Comments
 (0)