diff options
| author | Gregory Anders <greg@gpanders.com> | 2021-11-15 08:56:10 -0700 |
|---|---|---|
| committer | Gregory Anders <greg@gpanders.com> | 2021-11-15 09:12:27 -0700 |
| commit | 63413bd0478ebbb2aa5fc90b2533a04d8b785bbc (patch) | |
| tree | 928fbbd8e1979078da4986ce278be77b2e01e4a4 /runtime/doc | |
| parent | cc488376221e3792a2c69d1507bdfe405eaebc73 (diff) | |
| download | rneovim-63413bd0478ebbb2aa5fc90b2533a04d8b785bbc.tar.gz rneovim-63413bd0478ebbb2aa5fc90b2533a04d8b785bbc.tar.bz2 rneovim-63413bd0478ebbb2aa5fc90b2533a04d8b785bbc.zip | |
refactor(diagnostic)!: rename 'show_header' to 'header'
Rename the `show_header` option in `open_float` to simply `header` and
allow users to specify both the header string as well as the highlight
group.
Diffstat (limited to 'runtime/doc')
| -rw-r--r-- | runtime/doc/diagnostic.txt | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/runtime/doc/diagnostic.txt b/runtime/doc/diagnostic.txt index efcc90703f..6ada27edd0 100644 --- a/runtime/doc/diagnostic.txt +++ b/runtime/doc/diagnostic.txt @@ -375,8 +375,11 @@ config({opts}, {namespace}) *vim.diagnostic.config()* • float: Options for floating windows: • severity: See |diagnostic-severity|. - • show_header: (boolean, default true) Show - "Diagnostics:" header + • header: (string or table) String to use + as the header for the floating window. If + a table, it is interpreted as a [text, + hl_group] tuple. Defaults to + "Diagnostics:". • source: (string) Include the diagnostic source in the message. One of "always" or "if_many". @@ -620,9 +623,11 @@ open_float({bufnr}, {opts}) *vim.diagnostic.open_float()* |vim.diagnostic.config()|. • severity: See |diagnostic-severity|. Overrides the setting from |vim.diagnostic.config()|. - • show_header: (boolean, default true) Show - "Diagnostics:" header. Overrides the setting - from |vim.diagnostic.config()|. + • header: (string or table) String to use as the + header for the floating window. If a table, it + is interpreted as a [text, hl_group] tuple. + Overrides the setting from + |vim.diagnostic.config()|. • source: (string) Include the diagnostic source in the message. One of "always" or "if_many". Overrides the setting from |