diff options
| author | bfredl <bjorn.linse@gmail.com> | 2022-09-28 16:16:02 +0200 |
|---|---|---|
| committer | bfredl <bjorn.linse@gmail.com> | 2022-09-28 16:18:04 +0200 |
| commit | 47b821eccf7bd08f429bb16e9d4ea309d6994896 (patch) | |
| tree | f612b84a88b27bee45ad3f394587462b30a25ba6 | |
| parent | 39652100558726ab5fec86153e09816b7e7bf7f5 (diff) | |
| download | rneovim-47b821eccf7bd08f429bb16e9d4ea309d6994896.tar.gz rneovim-47b821eccf7bd08f429bb16e9d4ea309d6994896.tar.bz2 rneovim-47b821eccf7bd08f429bb16e9d4ea309d6994896.zip | |
docs: mark cmdheight=0 and vim.attach_ui as experimental
These will require further work for user experience out of the box
during the 0.9 cycle.
| -rw-r--r-- | runtime/doc/lua.txt | 6 | ||||
| -rw-r--r-- | runtime/doc/options.txt | 10 |
2 files changed, 13 insertions, 3 deletions
diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt index 0c6eb6af78..3026476ab9 100644 --- a/runtime/doc/lua.txt +++ b/runtime/doc/lua.txt @@ -978,6 +978,12 @@ vim.ui_attach({ns}, {options}, {callback}) *vim.ui_attach()* {callback} receives event name plus additional parameters. See |ui-popupmenu| and the sections below for event format for respective events. + WARNING: This api is considered experimental. Usability will vary for + different screen elements. In particular `ext_messages` behavior is subject + to further changes and usability improvements. This is expected to be + used to handle messages when setting 'cmdheight' to zero (which is + likewise experimental). + Example (stub for a |ui-popupmenu| implementation): > ns = vim.api.nvim_create_namespace('my_fancy_pum') diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index c1a0836f5b..0654265dbe 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -1338,9 +1338,13 @@ A jump table for the options with a short description can be found at |Q_op|. When 'cmdheight' is zero, there is no command-line unless it is being used. The command-line will cover the last line of the screen when - shown. Some informative messages will not be displayed, any other - messages will cause the |hit-enter| prompt. Expect some other - unexpected behavior too. + shown. + + WARNING: `cmdheight=0` is considered experimental. Except some + unwanted behaviour. Some 'shortmess' flags and similar + mechanism might fail to take effect, causing unwanted hit-enter + prompts. Some informative messages, both from Nvim itself and + plugins, will not be displayed. *'cmdwinheight'* *'cwh'* 'cmdwinheight' 'cwh' number (default 7) |