aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc
diff options
context:
space:
mode:
authorRaphael <glephunter@gmail.com>2023-12-13 22:19:53 +0800
committerGitHub <noreply@github.com>2023-12-13 08:19:53 -0600
commit8122470f8310ae34bcd5e436e8474f9255eb16f2 (patch)
tree2ee80d67ea635ff8b5b733ed8b69b71bc13e8ee3 /runtime/doc
parente527842211188a5c069ef4f4759aa291353b707f (diff)
downloadrneovim-8122470f8310ae34bcd5e436e8474f9255eb16f2.tar.gz
rneovim-8122470f8310ae34bcd5e436e8474f9255eb16f2.tar.bz2
rneovim-8122470f8310ae34bcd5e436e8474f9255eb16f2.zip
refactor(diagnostic): set sign by using extmark (#26193)
after sign implementation refactor by using extmark, we can use `nvim_buf_set_extmark` to set diagnostic sign instead use `sign_define`
Diffstat (limited to 'runtime/doc')
-rw-r--r--runtime/doc/diagnostic.txt10
-rw-r--r--runtime/doc/news.txt3
2 files changed, 13 insertions, 0 deletions
diff --git a/runtime/doc/diagnostic.txt b/runtime/doc/diagnostic.txt
index 7f5c809ac3..1e16edbdb2 100644
--- a/runtime/doc/diagnostic.txt
+++ b/runtime/doc/diagnostic.txt
@@ -435,6 +435,16 @@ config({opts}, {namespace}) *vim.diagnostic.config()*
for signs. When {severity_sort} is used, the priority
of a sign is adjusted based on its severity.
Otherwise, all signs use the same priority.
+ • text: (table) A table mapping |diagnostic-severity|
+ to the sign text to display in the sign column. The
+ default is to use "E", "W", "I", and "H" for errors,
+ warnings, information, and hints, respectively.
+ Example: >lua
+
+ vim.diagnostic.config({
+ sign = { text = { [vim.diagnostic.severity.ERROR] = 'E', ... } }
+ })
+<
• float: Options for floating windows. See
|vim.diagnostic.open_float()|.
diff --git a/runtime/doc/news.txt b/runtime/doc/news.txt
index 6166f4759d..04f143f0c3 100644
--- a/runtime/doc/news.txt
+++ b/runtime/doc/news.txt
@@ -341,6 +341,9 @@ The following changes to existing APIs or features add new behavior.
• Vimscript function |exists()| supports checking |v:lua| functions.
+• Diagnostic sign text is no longer configured with |sign_define()|.
+ Use |vim.diagnostic.config()| instead.
+
==============================================================================
REMOVED FEATURES *news-removed*