You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/content/wiki/diagnostics.mdx
+58
Original file line number
Diff line number
Diff line change
@@ -128,6 +128,16 @@ Triggered when the opinionated style checking detects an incorrectly styled line
128
128
129
129
</Diagnostic>
130
130
131
+
<Diagnosticlevel="Warning">
132
+
<Fragmentslot="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
+
131
141
<Diagnosticlevel="Information">
132
142
<Fragmentslot="name">
133
143
### spell-check
@@ -138,6 +148,20 @@ Triggered when a typo is detected in a string. The dictionary can be customized
138
148
139
149
</Diagnostic>
140
150
151
+
## conventions
152
+
153
+
The conventions group contains diagnostics for maintaining potentially subjective code conventions.
154
+
155
+
<Diagnosticlevel="Warning">
156
+
<Fragmentslot="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
+
141
165
## duplicate
142
166
143
167
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
304
328
305
329
</Diagnostic>
306
330
331
+
<Diagnosticlevel="Warning">
332
+
<Fragmentslot="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
+
<Diagnosticlevel="Warning">
343
+
<Fragmentslot="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
+
<Diagnosticlevel="Warning">
355
+
<Fragmentslot="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.
0 commit comments