From cc38086039853d53157b30fec41babb148399038 Mon Sep 17 00:00:00 2001 From: dundargoc <33953936+dundargoc@users.noreply.github.com> Date: Wed, 6 Dec 2023 01:04:21 +0100 Subject: [PATCH] docs: small fixes (#26243) Co-authored-by: umlx5h Co-authored-by: Gregory Anders Co-authored-by: Evan Farrar --- MAINTAIN.md | 2 +- runtime/doc/autocmd.txt | 4 ++-- runtime/doc/editorconfig.txt | 2 ++ runtime/doc/eval.txt | 2 +- runtime/doc/lua-guide.txt | 2 +- runtime/doc/quickref.txt | 10 +++++----- src/nvim/message.c | 2 +- test/functional/terminal/tui_spec.lua | 1 - test/unit/formatc.lua | 2 +- test/unit/helpers.lua | 2 +- 10 files changed, 15 insertions(+), 14 deletions(-) diff --git a/MAINTAIN.md b/MAINTAIN.md index 2fd43f3685..5e64b885d2 100644 --- a/MAINTAIN.md +++ b/MAINTAIN.md @@ -93,7 +93,7 @@ Example: ┆ ┆ ┆ ┆ Soft ┆ Hard ┆ ┆ Deprecation ┆ Deprecation ┆ - ┆ Period ┆ Preiod ┆ + ┆ Period ┆ Period ┆ ──────────────────────────────────────────────────────────── Version: 0.10 0.11 0.12 ──────────────────────────────────────────────────────────── diff --git a/runtime/doc/autocmd.txt b/runtime/doc/autocmd.txt index c6f6559e37..45d7a4244c 100644 --- a/runtime/doc/autocmd.txt +++ b/runtime/doc/autocmd.txt @@ -1001,10 +1001,10 @@ TermResponse When Nvim receives an OSC or DCS response from once = true, callback = function(args) local resp = args.data - local r, g, b = resp:match("\x1b%]4;1;rgb:(%w+)/(%w+)/(%w+)") + local r, g, b = resp:match("\027%]4;1;rgb:(%w+)/(%w+)/(%w+)") end, }) - io.stdout:write("\x1b]4;1;?\x1b\\") + io.stdout:write("\027]4;1;?\027\\") < *TextChanged* TextChanged After a change was made to the text in the diff --git a/runtime/doc/editorconfig.txt b/runtime/doc/editorconfig.txt index 7c6e8fb95f..a2281a7b7c 100644 --- a/runtime/doc/editorconfig.txt +++ b/runtime/doc/editorconfig.txt @@ -49,6 +49,8 @@ indent_size A number indicating the size of a single indent. Alternatively, use the value "tab" to use the value of the tab_width property. Sets the 'shiftwidth' and 'softtabstop' options. + If this value is not "tab" and the tab_width property + is not set, 'tabstop' is also set to this value. *editorconfig_insert_final_newline* insert_final_newline "true" or "false" to ensure the file always has a diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt index a73932be00..a3ba098740 100644 --- a/runtime/doc/eval.txt +++ b/runtime/doc/eval.txt @@ -4365,7 +4365,7 @@ have Vim execute random executables or may have forbidden to do so for specific filetypes by setting the "_exec" variable (|plugin_exec|). It returns |TRUE| or |FALSE| to indicate whether the plugin should run the given -exectuable. It takes the following arguments: +executable. It takes the following arguments: argument type ~ diff --git a/runtime/doc/lua-guide.txt b/runtime/doc/lua-guide.txt index c15b1b0495..e8757a1859 100644 --- a/runtime/doc/lua-guide.txt +++ b/runtime/doc/lua-guide.txt @@ -157,7 +157,7 @@ its functions if this succeeds and prints an error message otherwise: end < In contrast to |:source|, |require()| not only searches through all `lua/` directories -under |'runtimepath'|, it also cache the module on first use. Calling +under |'runtimepath'|, it also caches the module on first use. Calling `require()` a second time will therefore _not_ execute the script again and instead return the cached file. To rerun the file, you need to remove it from the cache manually first: diff --git a/runtime/doc/quickref.txt b/runtime/doc/quickref.txt index f976eb7464..572dc8a841 100644 --- a/runtime/doc/quickref.txt +++ b/runtime/doc/quickref.txt @@ -623,9 +623,9 @@ Short explanation of each option: *option-list* 'aleph' 'al' ASCII code of the letter Aleph (Hebrew) 'allowrevins' 'ari' allow CTRL-_ in Insert and Command-line mode 'ambiwidth' 'ambw' what to do with Unicode chars of ambiguous width -'autochdir' 'acd' change directory to the file in the current window 'arabic' 'arab' for Arabic as a default second language 'arabicshape' 'arshape' do shaping for Arabic characters +'autochdir' 'acd' change directory to the file in the current window 'autoindent' 'ai' take indent for new line from previous line 'autoread' 'ar' autom. read file when changed outside of Vim 'autowrite' 'aw' automatically write file if changed @@ -655,8 +655,8 @@ Short explanation of each option: *option-list* 'cindent' 'cin' do C program indenting 'cinkeys' 'cink' keys that trigger indent when 'cindent' is set 'cinoptions' 'cino' how to do indenting when 'cindent' is set -'cinwords' 'cinw' words where 'si' and 'cin' add an indent 'cinscopedecls' 'cinsd' words that are recognized by 'cino-g' +'cinwords' 'cinw' words where 'si' and 'cin' add an indent 'clipboard' 'cb' use the clipboard as the unnamed register 'cmdheight' 'ch' number of lines to use for the command-line 'cmdwinheight' 'cwh' height of the command-line window @@ -738,10 +738,10 @@ Short explanation of each option: *option-list* 'helpheight' 'hh' minimum height of a new help window 'helplang' 'hlg' preferred help languages 'hidden' 'hid' don't unload buffer when it is |abandon|ed -'hlsearch' 'hls' highlight matches with last search pattern 'history' 'hi' number of command-lines that are remembered 'hkmap' 'hk' Hebrew keyboard mapping 'hkmapp' 'hkp' phonetic Hebrew keyboard mapping +'hlsearch' 'hls' highlight matches with last search pattern 'icon' let Vim set the text of the window icon 'iconstring' string to use for the Vim icon text 'ignorecase' 'ic' ignore case in search patterns @@ -939,10 +939,10 @@ Short explanation of each option: *option-list* 'wildoptions' 'wop' specifies how command line completion is done 'winaltkeys' 'wak' when the windows system handles ALT keys 'window' 'wi' nr of lines to scroll for CTRL-F and CTRL-B -'winheight' 'wh' minimum number of lines for the current window -'winhighlight' 'winhl' window-local highlighting 'winfixheight' 'wfh' keep window height when opening/closing windows 'winfixwidth' 'wfw' keep window width when opening/closing windows +'winheight' 'wh' minimum number of lines for the current window +'winhighlight' 'winhl' window-local highlighting 'winminheight' 'wmh' minimum number of lines for any window 'winminwidth' 'wmw' minimal number of columns for any window 'winwidth' 'wiw' minimal number of columns for current window diff --git a/src/nvim/message.c b/src/nvim/message.c index 219532e45e..b9935d5b5d 100644 --- a/src/nvim/message.c +++ b/src/nvim/message.c @@ -2833,7 +2833,7 @@ static int do_more_prompt(int typed_char) } else { // redisplay all lines // TODO(bfredl): this case is not optimized (though only concerns - // event fragmentization, not unnecessary scroll events). + // event fragmentation, not unnecessary scroll events). grid_fill(&msg_grid_adj, 0, Rows, 0, Columns, ' ', ' ', HL_ATTR(HLF_MSG)); for (int i = 0; mp != NULL && i < Rows - 1; i++) { diff --git a/test/functional/terminal/tui_spec.lua b/test/functional/terminal/tui_spec.lua index e0216a22a7..3748f820d4 100644 --- a/test/functional/terminal/tui_spec.lua +++ b/test/functional/terminal/tui_spec.lua @@ -2599,7 +2599,6 @@ describe("TUI", function() end) end) --- See test/unit/tui_spec.lua for unit tests. describe('TUI bg color', function() local screen diff --git a/test/unit/formatc.lua b/test/unit/formatc.lua index 6bb58c68c3..ce9cb81f4a 100644 --- a/test/unit/formatc.lua +++ b/test/unit/formatc.lua @@ -209,7 +209,7 @@ local C_keywords = set { -- luacheck: ignore -- Very primitive C formatter that tries to put "things" inside braces on one -- line. This is a step done after preprocessing the C source to ensure that --- the duplicate line detecter can more reliably pick out identical declarations. +-- the duplicate line detector can more reliably pick out identical declarations. -- -- an example: -- struct mystruct diff --git a/test/unit/helpers.lua b/test/unit/helpers.lua index 0bd6b85570..86f3a7a662 100644 --- a/test/unit/helpers.lua +++ b/test/unit/helpers.lua @@ -212,7 +212,7 @@ local function cimport(...) -- give each #pragma pack an unique id, so that they don't get removed -- if they are inserted into the set -- (they are needed in the right order with the struct definitions, - -- otherwise luajit has wrong memory layouts for the sturcts) + -- otherwise luajit has wrong memory layouts for the structs) if line:match('#pragma%s+pack') then --- @type string line = line .. ' // ' .. pragma_pack_id