From 693aea0e9e1032aee85d56c1a3f33e0811dbdc18 Mon Sep 17 00:00:00 2001 From: dundargoc <33953936+dundargoc@users.noreply.github.com> Date: Tue, 19 Dec 2023 06:29:13 +0100 Subject: [PATCH] docs: small fixes (#26448) Co-authored-by: Gregory Anders <8965202+gpanders@users.noreply.github.com> Co-authored-by: Jordan Mandel --- README.md | 2 +- runtime/doc/deprecated.txt | 1 - runtime/doc/news.txt | 17 +++++++---------- runtime/doc/nvim_terminal_emulator.txt | 6 +++--- runtime/doc/options.txt | 4 ++-- runtime/lua/vim/_meta/options.lua | 4 ++-- src/nvim/options.lua | 4 ++-- test/old/testdir/test_map_functions.vim | 2 +- 8 files changed, 18 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index f5eebbc4da..71d611b582 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Neovim is a project that seeks to aggressively refactor [Vim](https://www.vim.or - Simplify maintenance and encourage [contributions](CONTRIBUTING.md) - Split the work between multiple developers - Enable [advanced UIs] without modifications to the core -- Maximize [extensibility](https://github.com/neovim/neovim/wiki/Remote-UI-architecture) +- Maximize [extensibility](https://neovim.io/doc/user/ui.html) See the [Introduction](https://github.com/neovim/neovim/wiki/Introduction) wiki page and [Roadmap] for more information. diff --git a/runtime/doc/deprecated.txt b/runtime/doc/deprecated.txt index b0d4b41a98..9d32f64aef 100644 --- a/runtime/doc/deprecated.txt +++ b/runtime/doc/deprecated.txt @@ -174,7 +174,6 @@ NORMAL COMMANDS OPTIONS - *cpo-<* *:menu-* *:menu-special* *:map-* *:map-special* `<>` notation is always enabled. -- 'gdefault' Enables the |:substitute| flag 'g' by default. - *'fe'* 'fenc'+'enc' before Vim 6.0; no longer used. - *'highlight'* *'hl'* Names of builtin |highlight-groups| cannot be changed. - *'langnoremap'* Deprecated alias to 'nolangremap'. diff --git a/runtime/doc/news.txt b/runtime/doc/news.txt index 90065349ef..f8d1dea78f 100644 --- a/runtime/doc/news.txt +++ b/runtime/doc/news.txt @@ -15,7 +15,7 @@ BREAKING CHANGES *news-breaking* The following changes may require adaptations in user config or plugins. -• In some cases, the cursor in the Nvim |TUI| would blink even without +• In some cases, the cursor in the Nvim |TUI| used to blink even without configuring 'guicursor' as mentioned in |cursor-blinking|. This was a bug that has now been fixed. If your cursor has stopped blinking, add the following (or similar, adapted to user preference) to your |config| file: >vim @@ -238,7 +238,7 @@ The following new APIs and features were added. • Floating windows can now be hidden by setting `hide` in |nvim_open_win()| or |nvim_win_set_config()|. -• The |:terminal| command now accepts some |:command-modifiers| (specifically +• |:terminal| command now accepts some |:command-modifiers| (specifically |:horizontal| and those that affect splitting a window). • |$NVIM_APPNAME| can be set to a relative path instead of only a name. @@ -259,16 +259,16 @@ The following new APIs and features were added. clipboard is now bundled by default and will be automatically enabled under certain conditions. |clipboard-osc52| -• The 'termsync' option asks the terminal emulator to buffer screen updates - until the redraw cycle is complete. Requires support from the terminal. +• 'termsync' option asks the terminal emulator to buffer screen updates until + the redraw cycle is complete. Requires support from the terminal. • |vim.text.hexencode()| and |vim.text.hexdecode()| convert strings to and from byte representations. -• 'completeopt' option supports "popup" flags to show extra information in - in floating window. +• 'completeopt' option supports "popup" flag to show extra information in a + floating window. -• Added `x1` and `x2` mouse buttons as possible arguments to |nvim_input_mouse()| +• |nvim_input_mouse()| supports mouse buttons "x1" and "x2". ============================================================================== CHANGED FEATURES *news-changed* @@ -359,9 +359,6 @@ The following changes to existing APIs or features add new behavior. • Vimscript function |exists()| supports checking |v:lua| functions. -• Diagnostic sign text is no longer configured with |sign_define()|. - Use |vim.diagnostic.config()| instead. - • Added "force_crlf" option field in |nvim_open_term()|. • Attempting to set an invalid keycode option (e.g. `set t_foo=123`) no longer diff --git a/runtime/doc/nvim_terminal_emulator.txt b/runtime/doc/nvim_terminal_emulator.txt index 557e714ddc..1b42892249 100644 --- a/runtime/doc/nvim_terminal_emulator.txt +++ b/runtime/doc/nvim_terminal_emulator.txt @@ -140,9 +140,9 @@ Example: >vim - |'channel'| Terminal PTY |job-id|. Can be used with |chansend()| to send input to the terminal. - The |TermClose| event gives the terminal job exit code in the |v:event| - "status" field. For example, this autocmd closes terminal buffers if the job - exited without error: >vim - autocmd TermClose * if !v:event.status | exe 'bdelete! '..expand('') | endif + "status" field. For example, this autocommand outputs the terminal's exit + code to |:messages|: >vim + autocmd TermClose * echom 'Terminal exited with status '..v:event.status Use |jobwait()| to check if the terminal job has finished: >vim let running = jobwait([&channel], 0)[0] == -1 diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 552ee96047..a3723f7459 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -1504,11 +1504,11 @@ A jump table for the options with a short description can be found at |Q_op|. completion in the preview window. Only works in combination with "menu" or "menuone". - noinsert Do not insert any text for a match until the user selects + noinsert Do not insert any text for a match until the user selects a match from the menu. Only works in combination with "menu" or "menuone". No effect if "longest" is present. - noselect Do not select a match in the menu, force the user to + noselect Do not select a match in the menu, force the user to select one from the menu. Only works in combination with "menu" or "menuone". diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua index e63c5bb972..6b7cfa79b3 100644 --- a/runtime/lua/vim/_meta/options.lua +++ b/runtime/lua/vim/_meta/options.lua @@ -1049,11 +1049,11 @@ vim.bo.cfu = vim.bo.completefunc --- completion in the preview window. Only works in --- combination with "menu" or "menuone". --- ---- noinsert Do not insert any text for a match until the user selects +--- noinsert Do not insert any text for a match until the user selects --- a match from the menu. Only works in combination with --- "menu" or "menuone". No effect if "longest" is present. --- ---- noselect Do not select a match in the menu, force the user to +--- noselect Do not select a match in the menu, force the user to --- select one from the menu. Only works in combination with --- "menu" or "menuone". --- diff --git a/src/nvim/options.lua b/src/nvim/options.lua index 0d5c24a793..cb25d481ec 100644 --- a/src/nvim/options.lua +++ b/src/nvim/options.lua @@ -1441,11 +1441,11 @@ return { completion in the preview window. Only works in combination with "menu" or "menuone". - noinsert Do not insert any text for a match until the user selects + noinsert Do not insert any text for a match until the user selects a match from the menu. Only works in combination with "menu" or "menuone". No effect if "longest" is present. - noselect Do not select a match in the menu, force the user to + noselect Do not select a match in the menu, force the user to select one from the menu. Only works in combination with "menu" or "menuone". diff --git a/test/old/testdir/test_map_functions.vim b/test/old/testdir/test_map_functions.vim index 2aeb470a0d..0898242154 100644 --- a/test/old/testdir/test_map_functions.vim +++ b/test/old/testdir/test_map_functions.vim @@ -593,7 +593,7 @@ func Test_maplist() call assert_equal(len(maps_maplist), len(map_set)) " For everything returned by maplist, should be the same as from maparg. - " Except for "map dup", bacause maparg returns the version + " Except for "map dup", because maparg returns the version for d in maps_maplist if d.lhs == 'dup' && d.buffer == 0 continue