aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc
diff options
context:
space:
mode:
authorglepnir <glephunter@gmail.com>2025-01-08 00:09:01 +0800
committerGitHub <noreply@github.com>2025-01-07 08:09:01 -0800
commitb12b91c2743954dbe8599caa60e58e5d74aa4e76 (patch)
tree54c5a31e53e96fa15a2218e6133275796f08b076 /runtime/doc
parentd9ee0d2984e5fc30cb032785d32f42c72c7e64e1 (diff)
downloadrneovim-b12b91c2743954dbe8599caa60e58e5d74aa4e76.tar.gz
rneovim-b12b91c2743954dbe8599caa60e58e5d74aa4e76.tar.bz2
rneovim-b12b91c2743954dbe8599caa60e58e5d74aa4e76.zip
feat(health): show :checkhealth in floating window #31086
Problem: health can not shown in a floating window Solution: add g:health variable
Diffstat (limited to 'runtime/doc')
-rw-r--r--runtime/doc/health.txt11
-rw-r--r--runtime/doc/lsp.txt2
-rw-r--r--runtime/doc/news.txt2
3 files changed, 14 insertions, 1 deletions
diff --git a/runtime/doc/health.txt b/runtime/doc/health.txt
index cb70961b55..bca145bd8e 100644
--- a/runtime/doc/health.txt
+++ b/runtime/doc/health.txt
@@ -21,6 +21,17 @@ To run all healthchecks, use: >vim
<
Plugin authors are encouraged to write new healthchecks. |health-dev|
+ *g:health*
+g:health This global variable controls the behavior and appearance of the
+ `health` floating window. It should be a dictionary containing the
+ following optional keys:
+ - `style`: string? Determines the display style of the `health` window.
+ Set to `'float'` to enable a floating window. Other
+ styles are not currently supported.
+
+ Example: >lua
+ vim.g.health = { style = 'float' }
+
Commands *health-commands*
*:che* *:checkhealth*
diff --git a/runtime/doc/lsp.txt b/runtime/doc/lsp.txt
index 71e8a12ca3..16e6abe294 100644
--- a/runtime/doc/lsp.txt
+++ b/runtime/doc/lsp.txt
@@ -2024,7 +2024,7 @@ Lua module: vim.lsp.util *lsp-util*
• {zindex}? (`integer`) override `zindex`, defaults to 50
• {title}? (`string`)
• {title_pos}? (`'left'|'center'|'right'`)
- • {relative}? (`'mouse'|'cursor'`) (default: `'cursor'`)
+ • {relative}? (`'mouse'|'cursor'|'editor'`) (default: `'cursor'`)
• {anchor_bias}? (`'auto'|'above'|'below'`, default: `'auto'`) -
"auto": place window based on which side of the
cursor has more lines
diff --git a/runtime/doc/news.txt b/runtime/doc/news.txt
index 17f85154c2..931f5e117c 100644
--- a/runtime/doc/news.txt
+++ b/runtime/doc/news.txt
@@ -359,6 +359,8 @@ UI
• |vim.diagnostic.setqflist()| updates an existing quickfix list with the
given title if found
• |ui-messages| content chunks now also contain the highlight group ID.
+• |:checkhealth| can be display in a floating window and controlled by
+ the |g:health| variable.
==============================================================================
CHANGED FEATURES *news-changed*