diff options
| author | zeertzjq <zeertzjq@outlook.com> | 2023-08-26 08:35:05 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-08-26 08:35:05 +0800 |
| commit | b1cfb299df2ef412339f594173ed23c75c090c8a (patch) | |
| tree | a69da4fdc1e11c05a6dd73c8740ce00dc469c576 /runtime/doc | |
| parent | 5d8ab32f3871b0232972cac1116ac7cba98389e5 (diff) | |
| download | rneovim-b1cfb299df2ef412339f594173ed23c75c090c8a.tar.gz rneovim-b1cfb299df2ef412339f594173ed23c75c090c8a.tar.bz2 rneovim-b1cfb299df2ef412339f594173ed23c75c090c8a.zip | |
docs: various clarifications (#24876)
Diffstat (limited to 'runtime/doc')
| -rw-r--r-- | runtime/doc/builtin.txt | 18 | ||||
| -rw-r--r-- | runtime/doc/lua.txt | 6 | ||||
| -rw-r--r-- | runtime/doc/options.txt | 5 |
3 files changed, 15 insertions, 14 deletions
diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt index 67a6b8df9c..9510f12045 100644 --- a/runtime/doc/builtin.txt +++ b/runtime/doc/builtin.txt @@ -8316,15 +8316,15 @@ type({expr}) *type()* The result is a Number representing the type of {expr}. Instead of using the number directly, it is better to use the v:t_ variable that has the value: - Number: 0 (|v:t_number|) - String: 1 (|v:t_string|) - Funcref: 2 (|v:t_func|) - List: 3 (|v:t_list|) - Dictionary: 4 (|v:t_dict|) - Float: 5 (|v:t_float|) - Boolean: 6 (|v:true| and |v:false|) - Null: 7 (|v:null|) - Blob: 10 (|v:t_blob|) + Number: 0 |v:t_number| + String: 1 |v:t_string| + Funcref: 2 |v:t_func| + List: 3 |v:t_list| + Dictionary: 4 |v:t_dict| + Float: 5 |v:t_float| + Boolean: 6 |v:t_bool| (|v:false| and |v:true|) + Null: 7 (|v:null|) + Blob: 10 |v:t_blob| For backward compatibility, this method can be used: >vim if type(myvar) == type(0) | endif if type(myvar) == type("") | endif diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt index b4ca88251e..39eb530c24 100644 --- a/runtime/doc/lua.txt +++ b/runtime/doc/lua.txt @@ -979,12 +979,12 @@ vim.str_utf_end({str}, {index}) *vim.str_utf_end()* Examples: >lua - -- The character 'æ' are equal to the bytes '\xc3\xa6' (using UTF-8) + -- The character 'æ' is stored as the bytes '\xc3\xa6' (using UTF-8) -- Returns 0 because the index is pointing at the last byte of a character vim.str_utf_end('æ', 2) - -- Returns 1 because the index is pointing at the second last byte of a character + -- Returns 1 because the index is pointing at the penultimate byte of a character vim.str_utf_end('æ', 1) < @@ -1016,7 +1016,7 @@ vim.str_utf_start({str}, {index}) *vim.str_utf_start()* Examples: >lua - -- The character 'æ' are equal to the bytes '\xc3\xa6' (using UTF-8) + -- The character 'æ' is stored as the bytes '\xc3\xa6' (using UTF-8) -- Returns 0 because the index is pointing at the first byte of a character vim.str_utf_start('æ', 1) diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index eea9f2cf4b..e2ca9c1992 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -4259,8 +4259,9 @@ A jump table for the options with a short description can be found at |Q_op|. 'mousescroll' string (default "ver:3,hor:6") global This option controls the number of lines / columns to scroll by when - scrolling with a mouse. The option is a comma separated list of parts. - Each part consists of a direction and a count as follows: + scrolling with a mouse wheel (|scroll-mouse-wheel|). The option is + a comma-separated list. Each part consists of a direction and a count + as follows: direction:count,direction:count Direction is one of either "hor" or "ver". "hor" controls horizontal scrolling and "ver" controls vertical scrolling. Count sets the amount |