aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNAKAI Tsuyoshi <82267684+uga-rosa@users.noreply.github.com>2023-06-28 00:14:17 +0900
committerGitHub <noreply@github.com>2023-06-27 08:14:17 -0700
commit929e4865d1f59cb356f3f2f8a10ad6095b435544 (patch)
tree67142bfa287ef1f0e60339433abd1b5842faf0e9
parent8ea9a70d05d6a7f9bab410101a87e6b184f14634 (diff)
downloadrneovim-929e4865d1f59cb356f3f2f8a10ad6095b435544.tar.gz
rneovim-929e4865d1f59cb356f3f2f8a10ad6095b435544.tar.bz2
rneovim-929e4865d1f59cb356f3f2f8a10ad6095b435544.zip
docs(diagnostic): return value of get() #24144
-rw-r--r--runtime/doc/diagnostic.txt2
-rw-r--r--runtime/lua/vim/diagnostic.lua2
2 files changed, 2 insertions, 2 deletions
diff --git a/runtime/doc/diagnostic.txt b/runtime/doc/diagnostic.txt
index bfcc1c9092..9dd42061ef 100644
--- a/runtime/doc/diagnostic.txt
+++ b/runtime/doc/diagnostic.txt
@@ -478,7 +478,7 @@ get({bufnr}, {opts}) *vim.diagnostic.get()*
• severity: See |diagnostic-severity|.
Return: ~
- Diagnostic [] table A list of diagnostic items |diagnostic-structure|.
+ Diagnostic [] table A list of diagnostic items |diagnostic-structure|. Keys `bufnr` , `end_lnum` , `end_col` , and `severity` are guaranteed to be present.
get_namespace({namespace}) *vim.diagnostic.get_namespace()*
Get namespace metadata.
diff --git a/runtime/lua/vim/diagnostic.lua b/runtime/lua/vim/diagnostic.lua
index 0d1d01b391..093bfb631e 100644
--- a/runtime/lua/vim/diagnostic.lua
+++ b/runtime/lua/vim/diagnostic.lua
@@ -767,7 +767,7 @@ end
--- - namespace: (number) Limit diagnostics to the given namespace.
--- - lnum: (number) Limit diagnostics to the given line number.
--- - severity: See |diagnostic-severity|.
----@return Diagnostic[] table A list of diagnostic items |diagnostic-structure|.
+---@return Diagnostic[] table A list of diagnostic items |diagnostic-structure|. Keys `bufnr`, `end_lnum`, `end_col`, and `severity` are guaranteed to be present.
function M.get(bufnr, opts)
vim.validate({
bufnr = { bufnr, 'n', true },