g:lsp_diagnostics_virtual_text_align: List allowed values (#1445)

It is not immediately clear what are the possible values for this
configuration parameter.  And it is nice to be a bit more explicit about
the meaning of each option.

Co-authored-by: Prabir Shrestha <mail@prabir.me>
This commit is contained in:
Illia Bobyr
2023-04-03 17:36:11 -07:00
committed by GitHub
parent 44608334f9
commit 7d59166b18

View File

@@ -745,6 +745,19 @@ g:lsp_diagnostics_virtual_text_align *g:lsp_diagnostics_virtual_text_align*
Determines the align of the diagnostics virtual text. Requires
|g:lsp_diagnostics_virtual_text_enabled|.
Possible values are:
after after the end of the line
right right aligned in the window (unless the text wraps to the next
screen line)
below in the next screen line
above just above the line
Only one "right" property can fit in each line, if there are two or more
these will go in a separate line (still right aligned).
This value is passed as the "text_align" property in a |prop_add()| call.
Example: >
let g:lsp_diagnostics_virtual_text_align = "right"