kevin/neovim
1
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2024-12-29 14:41:06 -07:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #20390 from bfredl/doc2

Browse Source 
docs: mark cmdheight=0 and vim.ui_attach as experimental
This commit is contained in:
bfredl 2022-09-28 19:00:54 +02:00 committed by GitHub
commit e8ff432922
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
runtime/doc/lua.txt
View File

@ -978,6 +978,12 @@ vim.ui_attach({ns}, {options}, {callback}) *vim.ui_attach()*
{callback} receives event name plus additional parameters. See |ui-popupmenu| {callback} receives event name plus additional parameters. See |ui-popupmenu|
and the sections below for event format for respective events. 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): > Example (stub for a |ui-popupmenu| implementation): >
ns = vim.api.nvim_create_namespace('my_fancy_pum') ns = vim.api.nvim_create_namespace('my_fancy_pum')

10
runtime/doc/options.txt
View File

@ -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 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 used. The command-line will cover the last line of the screen when
shown. Some informative messages will not be displayed, any other shown.
messages will cause the |hit-enter| prompt. Expect some other
unexpected behavior too. 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'*
'cmdwinheight' 'cwh' number (default 7) 'cmdwinheight' 'cwh' number (default 7)