From add1b10b79011d1af61419a63cc8ef4645f45bbf Mon Sep 17 00:00:00 2001 From: Jongwook Choi Date: Fri, 27 Oct 2023 09:17:46 -0400 Subject: fix(diagnostic): virtual_text prefix function should have index and total (#25801) The prefix option of the diagnostic virtual text can be a function, but previously it was only a function of diagnostic. This function should also have additional parameters index and total, more consistently and similarily as in the prefix function for `vim.diagnostic.open_float()`. These additional parameters will be useful when there are too many number of diagnostics in a single line. --- runtime/doc/diagnostic.txt | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) (limited to 'runtime/doc') diff --git a/runtime/doc/diagnostic.txt b/runtime/doc/diagnostic.txt index e9ca9ee347..7f5c809ac3 100644 --- a/runtime/doc/diagnostic.txt +++ b/runtime/doc/diagnostic.txt @@ -404,9 +404,12 @@ config({opts}, {namespace}) *vim.diagnostic.config()* the beginning of the virtual text. • prefix: (string or function) prepend diagnostic message with prefix. If a function, it must have the - signature (diagnostic) -> string, where {diagnostic} - is of type |diagnostic-structure|. This can be used - to render diagnostic symbols or error codes. + signature (diagnostic, i, total) -> string, where + {diagnostic} is of type |diagnostic-structure|, {i} + is the index of the diagnostic being evaluated, and + {total} is the total number of diagnostics for the + line. This can be used to render diagnostic symbols + or error codes. • suffix: (string or function) Append diagnostic message with suffix. If a function, it must have the signature (diagnostic) -> string, where {diagnostic} -- cgit