Skip to content

Commit ea03a5b

Browse files
eduardorittnerSmithx10
authored andcommitted
Document diagnostic severity levels (helix-editor#12306)
1 parent efcac86 commit ea03a5b

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

book/src/editor.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -443,6 +443,8 @@ fn main() {
443443
| `max-wrap` | Equivalent of the `editor.soft-wrap.max-wrap` option for diagnostics. | `20` |
444444
| `max-diagnostics` | Maximum number of diagnostics to render inline for a given line | `10` |
445445
446+
The allowed values for `cursor-line` and `other-lines` are: `error`, `warning`, `info`, `hint`.
447+
446448
The (first) diagnostic with the highest severity that is not shown inline is rendered at the end of the line (as long as its severity is higher than the `end-of-line-diagnostics` config option):
447449
448450
```

book/src/languages.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ These configuration keys are available:
6060
| `shebangs` | The interpreters from the shebang line, for example `["sh", "bash"]` |
6161
| `roots` | A set of marker files to look for when trying to find the workspace root. For example `Cargo.lock`, `yarn.lock` |
6262
| `auto-format` | Whether to autoformat this language when saving |
63-
| `diagnostic-severity` | Minimal severity of diagnostic for it to be displayed. (Allowed values: `Error`, `Warning`, `Info`, `Hint`) |
63+
| `diagnostic-severity` | Minimal severity of diagnostic for it to be displayed. (Allowed values: `error`, `warning`, `info`, `hint`) |
6464
| `comment-tokens` | The tokens to use as a comment token, either a single token `"//"` or an array `["//", "///", "//!"]` (the first token will be used for commenting). Also configurable as `comment-token` for backwards compatibility|
6565
| `block-comment-tokens`| The start and end tokens for a multiline comment either an array or single table of `{ start = "/*", end = "*/"}`. The first set of tokens will be used for commenting, any pairs in the array can be uncommented |
6666
| `indent` | The indent to use. Has sub keys `unit` (the text inserted into the document when indenting; usually set to N spaces or `"\t"` for tabs) and `tab-width` (the number of spaces rendered for a tab) |

0 commit comments

Comments
 (0)