aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc
diff options
context:
space:
mode:
authorbeardedsakimonkey <54521218+beardedsakimonkey@users.noreply.github.com>2022-11-20 23:57:36 +0000
committerGitHub <noreply@github.com>2022-11-20 16:57:36 -0700
commit126ef65e5b3ff0da68bfe166be0bb0a33664142b (patch)
treef47d165c647ab7c5665d51ff618a8d07a92a4ce7 /runtime/doc
parentfbce9f421ad1ad466126a24524ade9df978486d5 (diff)
downloadrneovim-126ef65e5b3ff0da68bfe166be0bb0a33664142b.tar.gz
rneovim-126ef65e5b3ff0da68bfe166be0bb0a33664142b.tar.bz2
rneovim-126ef65e5b3ff0da68bfe166be0bb0a33664142b.zip
feat(diagnostic): add `suffix` option to `virt_text` config (#21140)
This introduces a `suffix` option to the `virt_text` config in `vim.diagnostic.config()`. The suffix can either be a string which is appended to the diagnostic message or a function returning such. The function receives a `diagnostic` argument, which is the diagnostic table of the last diagnostic (the one whose message is rendered as virt text).
Diffstat (limited to 'runtime/doc')
-rw-r--r--runtime/doc/diagnostic.txt5
1 files changed, 5 insertions, 0 deletions
diff --git a/runtime/doc/diagnostic.txt b/runtime/doc/diagnostic.txt
index 53046b399f..a2bacebc72 100644
--- a/runtime/doc/diagnostic.txt
+++ b/runtime/doc/diagnostic.txt
@@ -365,6 +365,11 @@ config({opts}, {namespace}) *vim.diagnostic.config()*
the beginning of the virtual text.
• prefix: (string) Prepend diagnostic message with
prefix.
+ • suffix: (string or function) Append diagnostic
+ message with suffix. If a function, it must have the
+ signature (diagnostic) -> string, where {diagnostic}
+ is of type |diagnostic-structure|. This can be used
+ to render an LSP diagnostic error code.
• format: (function) A function that takes a diagnostic
as input and returns a string. The return value is
the text used to display the diagnostic. Example: >