diff options
| author | David Shen <17462095+mxteries@users.noreply.github.com> | 2022-03-02 20:42:27 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-03-02 18:42:27 -0700 |
| commit | 5d6006f9bfc2f1f064adbcfa974da6976e867450 (patch) | |
| tree | d8591aedcdf6652e4b4d3e3f3223f817a56d7f21 /runtime/doc | |
| parent | 051a0514dc62f675a3c63761b9bef1721f7cf695 (diff) | |
| download | rneovim-5d6006f9bfc2f1f064adbcfa974da6976e867450.tar.gz rneovim-5d6006f9bfc2f1f064adbcfa974da6976e867450.tar.bz2 rneovim-5d6006f9bfc2f1f064adbcfa974da6976e867450.zip | |
feat(diagnostic): add "code" to the diagnostic structure (#17510)
Diffstat (limited to 'runtime/doc')
| -rw-r--r-- | runtime/doc/diagnostic.txt | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/runtime/doc/diagnostic.txt b/runtime/doc/diagnostic.txt index 19db3158be..781539cfb6 100644 --- a/runtime/doc/diagnostic.txt +++ b/runtime/doc/diagnostic.txt @@ -39,16 +39,18 @@ modify the diagnostics for a buffer (e.g. |vim.diagnostic.set()|) then it requires a namespace. *diagnostic-structure* -A diagnostic is a Lua table with the following keys: +A diagnostic is a Lua table with the following keys. Required keys are +indicated with (*): bufnr: Buffer number - lnum: The starting line of the diagnostic + lnum(*): The starting line of the diagnostic end_lnum: The final line of the diagnostic - col: The starting column of the diagnostic + col(*): The starting column of the diagnostic end_col: The final column of the diagnostic severity: The severity of the diagnostic |vim.diagnostic.severity| - message: The diagnostic text + message(*): The diagnostic text source: The source of the diagnostic + code: The diagnostic code user_data: Arbitrary data plugins or users can add Diagnostics use the same indexing as the rest of the Nvim API (i.e. 0-based |