Skip to content

add: documentation for some missing diagnostics #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 14, 2024
Merged

add: documentation for some missing diagnostics #37

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 58 additions & 0 deletions src/content/wiki/diagnostics.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,16 @@ Triggered when the opinionated style checking detects an incorrectly styled line

</Diagnostic>

<Diagnostic level="Warning">
<Fragment slot="name">
### name-style-check
</Fragment>
**Default File Status:** `"None"`

Triggered when the opinionated style checking detects an incorrectly named element.

</Diagnostic>

<Diagnostic level="Information">
<Fragment slot="name">
### spell-check
Expand All @@ -138,6 +148,20 @@ Triggered when a typo is detected in a string. The dictionary can be customized

</Diagnostic>

## conventions

The conventions group contains diagnostics for maintaining potentially subjective code conventions.

<Diagnostic level="Warning">
<Fragment slot="name">
### global-element
</Fragment>
**Default File Status:** `"None"`

Triggered when an element is not declared `local` to avoid accidentally global elements.

</Diagnostic>

## duplicate

The duplicate group contains diagnostics for duplicate indexes and names.
Expand Down Expand Up @@ -304,6 +328,40 @@ Triggered when there are two [`@param`](/wiki/annotations#param) annotations wit

</Diagnostic>

<Diagnostic level="Warning">
<Fragment slot="name">
### incomplete-signature-doc
</Fragment>
**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.

</Diagnostic>

<Diagnostic level="Warning">
<Fragment slot="name">
### missing-global-doc
</Fragment>
**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.

</Diagnostic>

<Diagnostic level="Warning">
<Fragment slot="name">
### missing-local-export-doc
</Fragment>
**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.

</Diagnostic>

<Diagnostic level="Warning">
<Fragment slot="name">
### undefined-doc-class
Expand Down