diff options
author | dundargoc <33953936+dundargoc@users.noreply.github.com> | 2023-09-14 06:05:27 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-09-14 12:05:27 +0800 |
commit | a6e74c1f0a2bbf03f5b99c167b549018f4c8fb0d (patch) | |
tree | c1d7f91607bf0588b689a817d291add77a8ea957 | |
parent | f5953edbac14febce9d4f8a3c35bdec1eae26fbe (diff) | |
download | rneovim-a6e74c1f0a2bbf03f5b99c167b549018f4c8fb0d.tar.gz rneovim-a6e74c1f0a2bbf03f5b99c167b549018f4c8fb0d.tar.bz2 rneovim-a6e74c1f0a2bbf03f5b99c167b549018f4c8fb0d.zip |
docs: fix typos and other small fixes (#25005)
Co-authored-by: nuid64 <lvkuzvesov@proton.me>
Co-authored-by: Mike Smith <10135646+mikesmithgh@users.noreply.github.com>
Co-authored-by: XTY <xty@xty.io>
Co-authored-by: Empa <emanuel@empa.xyz>
Co-authored-by: kyu08 <49891479+kyu08@users.noreply.github.com>
-rw-r--r-- | runtime/doc/builtin.txt | 2 | ||||
-rw-r--r-- | runtime/doc/lsp.txt | 2 | ||||
-rw-r--r-- | runtime/doc/lua.txt | 4 | ||||
-rw-r--r-- | runtime/doc/options.txt | 6 | ||||
-rw-r--r-- | runtime/lua/vim/_editor.lua | 2 | ||||
-rw-r--r-- | runtime/lua/vim/_meta/options.lua | 6 | ||||
-rw-r--r-- | runtime/lua/vim/_meta/regex.lua | 2 | ||||
-rw-r--r-- | runtime/lua/vim/_meta/vimfn.lua | 2 | ||||
-rw-r--r-- | src/nvim/README.md | 3 | ||||
-rw-r--r-- | src/nvim/autocmd.c | 2 | ||||
-rw-r--r-- | src/nvim/eval.lua | 2 | ||||
-rw-r--r-- | src/nvim/eval/funcs.c | 2 | ||||
-rw-r--r-- | src/nvim/eval/vars.c | 2 | ||||
-rw-r--r-- | src/nvim/grid_defs.h | 2 | ||||
-rw-r--r-- | src/nvim/options.lua | 6 |
15 files changed, 22 insertions, 23 deletions
diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt index 400cd27302..05db977809 100644 --- a/runtime/doc/builtin.txt +++ b/runtime/doc/builtin.txt @@ -5211,7 +5211,7 @@ printf({fmt}, {expr1} ...) *printf()* *printf-$* In certain languages, error and informative messages are more readable when the order of words is different from the - corresponding message in English. To accomodate translations + corresponding message in English. To accommodate translations having a different word order, positional arguments may be used to indicate this. For instance: >vim diff --git a/runtime/doc/lsp.txt b/runtime/doc/lsp.txt index 1e57b85153..29c08fb32d 100644 --- a/runtime/doc/lsp.txt +++ b/runtime/doc/lsp.txt @@ -578,7 +578,7 @@ LspRequest *LspRequest* "data" table passed to the callback function. It triggers when the initial request is sent ({type} == `pending`) and - when the LSP server responds ({type} == `complete`). If a cancelation + when the LSP server responds ({type} == `complete`). If a cancellation is requested using `client.cancel_request(request_id)`, then this event will trigger with {type} == `cancel`. diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt index 61afd4698a..c7f5a292e7 100644 --- a/runtime/doc/lua.txt +++ b/runtime/doc/lua.txt @@ -674,7 +674,7 @@ vim.regex:match_line({bufnr}, {line_idx}, {start}, {end_}) vim.regex:match_str({str}) *regex:match_str()* Match the string against the regex. If the string should match the regex precisely, surround the regex with `^` and `$` . If there was a match, the byte indices for the beginning and end of the - match are returned. When there is no match, `nil` is returned. Because any integer is "truthy", `regex:match()` can be directly used as a condition in an if-statement. + match are returned. When there is no match, `nil` is returned. Because any integer is "truthy", `regex:match_str()` can be directly used as a condition in an if-statement. Parameters: ~ • {str} (string) @@ -1772,7 +1772,7 @@ vim.system({cmd}, {opts}, {on_exit}) *vim.system()* • stdout: (boolean|function) Handle output from stdout. When passed as a function must have the signature `fun(err: string, data: string)`. Defaults to `true` - • stderr: (boolean|function) Handle output from stdout. + • stderr: (boolean|function) Handle output from stderr. When passed as a function must have the signature `fun(err: string, data: string)`. Defaults to `true`. • text: (boolean) Handle stdout and stderr as text. diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 68be0da2fd..f758782f09 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -2901,10 +2901,10 @@ A jump table for the options with a short description can be found at |Q_op|. n-v-c-sm:block,i-ci-ve:ver25-Cursor,r-cr-o:hor20 In Normal et al. modes, use a block cursor with the default colors defined by the host - terminal. In Insert-likes modes, use + terminal. In Insert-like modes, use a vertical bar cursor with colors from - "Cursor" highlight group. In Replace-likes - modes, use a underline cursor with + "Cursor" highlight group. In Replace-like + modes, use an underline cursor with default colors. i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150 In Insert and Command-line Insert mode, use a diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua index 68992a16bb..64aeb64736 100644 --- a/runtime/lua/vim/_editor.lua +++ b/runtime/lua/vim/_editor.lua @@ -104,7 +104,7 @@ vim.log = { --- Handle output from stdout. When passed as a function must have the signature `fun(err: string, data: string)`. --- Defaults to `true` --- - stderr: (boolean|function) ---- Handle output from stdout. When passed as a function must have the signature `fun(err: string, data: string)`. +--- Handle output from stderr. When passed as a function must have the signature `fun(err: string, data: string)`. --- Defaults to `true`. --- - text: (boolean) Handle stdout and stderr as text. Replaces `\r\n` with `\n`. --- - timeout: (integer) Run the command with a time limit. Upon timeout the process is sent the diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua index 4fb3141df0..92dc4b2c7f 100644 --- a/runtime/lua/vim/_meta/options.lua +++ b/runtime/lua/vim/_meta/options.lua @@ -2697,10 +2697,10 @@ vim.go.gp = vim.go.grepprg --- n-v-c-sm:block,i-ci-ve:ver25-Cursor,r-cr-o:hor20 --- In Normal et al. modes, use a block cursor --- with the default colors defined by the host ---- terminal. In Insert-likes modes, use +--- terminal. In Insert-like modes, use --- a vertical bar cursor with colors from ---- "Cursor" highlight group. In Replace-likes ---- modes, use a underline cursor with +--- "Cursor" highlight group. In Replace-like +--- modes, use an underline cursor with --- default colors. --- i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150 --- In Insert and Command-line Insert mode, use a diff --git a/runtime/lua/vim/_meta/regex.lua b/runtime/lua/vim/_meta/regex.lua index ab4f46d43f..58aa2be8c2 100644 --- a/runtime/lua/vim/_meta/regex.lua +++ b/runtime/lua/vim/_meta/regex.lua @@ -21,7 +21,7 @@ local regex = {} -- luacheck: no unused --- precisely, surround the regex with `^` and `$`. If there was a match, the --- byte indices for the beginning and end of the match are returned. When --- there is no match, `nil` is returned. Because any integer is "truthy", ---- `regex:match()` can be directly used as a condition in an if-statement. +--- `regex:match_str()` can be directly used as a condition in an if-statement. --- @param str string function regex:match_str(str) end diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua index 6209ce0c73..efb779ad41 100644 --- a/runtime/lua/vim/_meta/vimfn.lua +++ b/runtime/lua/vim/_meta/vimfn.lua @@ -6194,7 +6194,7 @@ function vim.fn.prevnonblank(lnum) end --- *printf-$* --- In certain languages, error and informative messages are --- more readable when the order of words is different from the ---- corresponding message in English. To accomodate translations +--- corresponding message in English. To accommodate translations --- having a different word order, positional arguments may be --- used to indicate this. For instance: >vim --- diff --git a/src/nvim/README.md b/src/nvim/README.md index 0de0fb9a3f..4029777031 100644 --- a/src/nvim/README.md +++ b/src/nvim/README.md @@ -1,8 +1,7 @@ Nvim core ========= -Module-specific details are documented at the top of each module (`terminal.c`, -`screen.c`, …). +Module-specific details are documented at the top of each module (`terminal.c`, `undo.c`, …). See `:help dev` for guidelines. diff --git a/src/nvim/autocmd.c b/src/nvim/autocmd.c index 5f94fbb014..3fa20f4e48 100644 --- a/src/nvim/autocmd.c +++ b/src/nvim/autocmd.c @@ -2524,7 +2524,7 @@ static bool arg_autocmd_flag_get(bool *flag, char **cmd_ptr, char *pattern, int } /// When kFalse: VimSuspend should be triggered next. -/// When kTrue: VimResume should be triggerd next. +/// When kTrue: VimResume should be triggered next. /// When kNone: Currently triggering VimSuspend or VimResume. static TriState pending_vimresume = kFalse; diff --git a/src/nvim/eval.lua b/src/nvim/eval.lua index a9200d1f5f..e6efbe85d8 100644 --- a/src/nvim/eval.lua +++ b/src/nvim/eval.lua @@ -7472,7 +7472,7 @@ M.funcs = { *printf-$* In certain languages, error and informative messages are more readable when the order of words is different from the - corresponding message in English. To accomodate translations + corresponding message in English. To accommodate translations having a different word order, positional arguments may be used to indicate this. For instance: >vim diff --git a/src/nvim/eval/funcs.c b/src/nvim/eval/funcs.c index 1ed0994222..93075cf0e2 100644 --- a/src/nvim/eval/funcs.c +++ b/src/nvim/eval/funcs.c @@ -6329,7 +6329,7 @@ static void reduce_string(typval_T *argvars, typval_T *expr, typval_T *rettv) } } -/// Implementaion of reduce() for Blob "argvars[0]" using the function "expr" +/// Implementation of reduce() for Blob "argvars[0]" using the function "expr" /// starting with the optional initial value "argvars[2]" and return the result /// in "rettv". static void reduce_blob(typval_T *argvars, typval_T *expr, typval_T *rettv) diff --git a/src/nvim/eval/vars.c b/src/nvim/eval/vars.c index 9b6427fef7..e5b1b88eef 100644 --- a/src/nvim/eval/vars.c +++ b/src/nvim/eval/vars.c @@ -1810,7 +1810,7 @@ static void getwinvar(typval_T *argvars, typval_T *rettv, int off) /// @param[in] tv typval to convert. /// @param[in] option Option name. /// @param[in] flags Option flags. -/// @param[out] error Whether an error occured. +/// @param[out] error Whether an error occurred. /// /// @return Typval converted to OptVal. Must be freed by caller. /// Returns NIL_OPTVAL for invalid option name. diff --git a/src/nvim/grid_defs.h b/src/nvim/grid_defs.h index aeaadea73c..4ad7d4cdb4 100644 --- a/src/nvim/grid_defs.h +++ b/src/nvim/grid_defs.h @@ -39,7 +39,7 @@ enum { /// /// attrs[] contains the highlighting attribute for each cell. /// -/// vcols[] countain the virtual columns in the line. -1 means not available +/// vcols[] contains the virtual columns in the line. -1 means not available /// (below last line), MAXCOL means after the end of the line. /// /// line_offset[n] is the offset from chars[], attrs[] and vcols[] for the start diff --git a/src/nvim/options.lua b/src/nvim/options.lua index b774df476f..f0666101b8 100644 --- a/src/nvim/options.lua +++ b/src/nvim/options.lua @@ -3441,10 +3441,10 @@ return { n-v-c-sm:block,i-ci-ve:ver25-Cursor,r-cr-o:hor20 In Normal et al. modes, use a block cursor with the default colors defined by the host - terminal. In Insert-likes modes, use + terminal. In Insert-like modes, use a vertical bar cursor with colors from - "Cursor" highlight group. In Replace-likes - modes, use a underline cursor with + "Cursor" highlight group. In Replace-like + modes, use an underline cursor with default colors. i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150 In Insert and Command-line Insert mode, use a |