docs: various clarifications (#24876)

This commit is contained in:
zeertzjq
2023-08-26 08:35:05 +08:00
committed by GitHub
parent 5d8ab32f38
commit b1cfb299df
10 changed files with 43 additions and 41 deletions

View File

@@ -132,7 +132,7 @@ function vim.str_utf_pos(str) end
---
--- Examples:
--- <pre>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)
@@ -151,12 +151,12 @@ function vim.str_utf_start(str, index) end
---
--- Examples:
--- <pre>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)
--- </pre>
---

View File

@@ -4323,8 +4323,9 @@ vim.go.mousemoveevent = vim.o.mousemoveevent
vim.go.mousemev = vim.go.mousemoveevent
--- 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

View File

@@ -9878,15 +9878,15 @@ function vim.fn.trunc(expr) end
--- 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