diff options
author | dundargoc <33953936+dundargoc@users.noreply.github.com> | 2022-04-15 12:35:06 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-04-15 12:35:06 +0200 |
commit | e63e5d1dbd3dd4711efa0ecf9e844ff308b370a6 (patch) | |
tree | a05cf2f0a352b6bf3db38e5c7a57842615cc4a48 /runtime | |
parent | 4503cb6b642e0b1ba8157154af6a220387e607f0 (diff) | |
download | rneovim-e63e5d1dbd3dd4711efa0ecf9e844ff308b370a6.tar.gz rneovim-e63e5d1dbd3dd4711efa0ecf9e844ff308b370a6.tar.bz2 rneovim-e63e5d1dbd3dd4711efa0ecf9e844ff308b370a6.zip |
docs: typo fixes (#17859)
Co-authored-by: Elias Alves Moura <eliamoura.alves@gmail.com>
Co-authored-by: venkatesh <shariharanvenkatesh@gmail.com>
Co-authored-by: zeertzjq <zeertzjq@outlook.com>
Co-authored-by: Vikas Raj <24727447+numToStr@users.noreply.github.com>
Co-authored-by: Steve Vermeulen <sfvermeulen@gmail.com>
Co-authored-by: Evgeni Chasnovski <evgeni.chasnovski@gmail.com>
Co-authored-by: rwxd <rwxd@pm.me>
Co-authored-by: casswedson <58050969+casswedson@users.noreply.github.com>
Diffstat (limited to 'runtime')
-rw-r--r-- | runtime/doc/api.txt | 9 | ||||
-rw-r--r-- | runtime/doc/builtin.txt | 2 | ||||
-rw-r--r-- | runtime/doc/lua.txt | 4 | ||||
-rw-r--r-- | runtime/doc/options.txt | 2 | ||||
-rw-r--r-- | runtime/doc/term.txt | 2 | ||||
-rw-r--r-- | runtime/doc/treesitter.txt | 2 | ||||
-rw-r--r-- | runtime/lua/vim/ui.lua | 2 |
7 files changed, 10 insertions, 13 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index 858258320d..9e0002db48 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -2859,8 +2859,7 @@ nvim_win_set_cursor({window}, {pos}) *nvim_win_set_cursor()* {pos} (row, col) tuple representing the new position nvim_win_set_height({window}, {height}) *nvim_win_set_height()* - Sets the window height. This will only succeed if the screen - is split horizontally. + Sets the window height. Parameters: ~ {window} Window handle, or 0 for current window @@ -3234,9 +3233,9 @@ nvim_create_autocmd({event}, {*opts}) *nvim_create_autocmd()* pattern = { "*.py", "*.pyi" } < - Examples values for event: > - "BufPreWrite" - {"CursorHold", "BufPreWrite", "BufPostWrite"} + Example values for event: > + "BufWritePre" + {"CursorHold", "BufWritePre", "BufWritePost"} < Parameters: ~ diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt index 49aa52a92f..7871885a5d 100644 --- a/runtime/doc/builtin.txt +++ b/runtime/doc/builtin.txt @@ -966,8 +966,6 @@ byteidxcomp({expr}, {nr}) *byteidxcomp()* < The first and third echo result in 3 ('e' plus composing character is 3 bytes), the second echo results in 1 ('e' is one byte). - Only works differently from byteidx() when 'encoding' is set - to a Unicode encoding. Can also be used as a |method|: > GetName()->byteidxcomp(idx) diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt index 46b9f0576f..16f27486c8 100644 --- a/runtime/doc/lua.txt +++ b/runtime/doc/lua.txt @@ -1151,7 +1151,7 @@ In any of the above examples, to replicate the behavior |setlocal|, use |vim.opt| returns an Option object. -For example: `local listchar_object = vim.opt.listchar` +For example: `local listchar_object = vim.opt.listchars` An `Option` has the following methods: @@ -1910,7 +1910,7 @@ select({items}, {opts}, {on_choice}) *vim.ui.select()* which select() was called. {on_choice} function ((item|nil, idx|nil) -> ()) Called once the user made a choice. `idx` is the - 1-based index of `item` within `item`. `nil` + 1-based index of `item` within `items`. `nil` if the user aborted the dialog. diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 8d353804a4..7ea6a92a34 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -921,7 +921,7 @@ A jump table for the options with a short description can be found at |Q_op|. Note that environment variables are not expanded. If you want to use $HOME you must expand it explicitly, e.g.: > - :let backupskip = escape(expand('$HOME'), '\') .. '/tmp/*' + :let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*' < Note that the default also makes sure that "crontab -e" works (when a backup would be made by renaming the original file crontab won't see diff --git a/runtime/doc/term.txt b/runtime/doc/term.txt index ddf52b65c6..bdf0094721 100644 --- a/runtime/doc/term.txt +++ b/runtime/doc/term.txt @@ -111,7 +111,7 @@ width of the terminal. *tui-input* Nvim uses libtermkey to convert terminal escape sequences to key codes. |terminfo| is used first, and CSI sequences not in |terminfo| (including -exteneded keys a.k.a. modifyOtherKeys or `CSI u`) can also be parsed. +extended keys a.k.a. modifyOtherKeys or `CSI u`) can also be parsed. For example, when running Nvim in tmux, this makes Nvim leave Insert mode and go to the window below: > tmux send-keys 'Escape' [ 2 7 u 'C-W' j diff --git a/runtime/doc/treesitter.txt b/runtime/doc/treesitter.txt index a9d9f81849..b10bf3498d 100644 --- a/runtime/doc/treesitter.txt +++ b/runtime/doc/treesitter.txt @@ -268,7 +268,7 @@ Here is a list of built-in directives: ((identifier) @foo (#set! @foo "kind" "parameter")) ((node1) @left (node2) @right (#set! "type" "pair")) < - `offset!` *ts-predicate-offset!* + `offset!` *ts-directive-offset!* Takes the range of the captured node and applies the offsets to it's range : > ((identifier) @constant (#offset! @constant 0 1 0 -1)) diff --git a/runtime/lua/vim/ui.lua b/runtime/lua/vim/ui.lua index 9d4b38f08a..165dada1b8 100644 --- a/runtime/lua/vim/ui.lua +++ b/runtime/lua/vim/ui.lua @@ -16,7 +16,7 @@ local M = {} --- `items`, or the context in which select() was called. ---@param on_choice function ((item|nil, idx|nil) -> ()) --- Called once the user made a choice. ---- `idx` is the 1-based index of `item` within `item`. +--- `idx` is the 1-based index of `item` within `items`. --- `nil` if the user aborted the dialog. --- --- |