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

@@ -8316,15 +8316,15 @@ type({expr}) *type()*
The result is a Number representing the type of {expr}. The result is a Number representing the type of {expr}.
Instead of using the number directly, it is better to use the Instead of using the number directly, it is better to use the
v:t_ variable that has the value: v:t_ variable that has the value:
Number: 0 (|v:t_number|) Number: 0 |v:t_number|
String: 1 (|v:t_string|) String: 1 |v:t_string|
Funcref: 2 (|v:t_func|) Funcref: 2 |v:t_func|
List: 3 (|v:t_list|) List: 3 |v:t_list|
Dictionary: 4 (|v:t_dict|) Dictionary: 4 |v:t_dict|
Float: 5 (|v:t_float|) Float: 5 |v:t_float|
Boolean: 6 (|v:true| and |v:false|) Boolean: 6 |v:t_bool| (|v:false| and |v:true|)
Null: 7 (|v:null|) Null: 7 (|v:null|)
Blob: 10 (|v:t_blob|) Blob: 10 |v:t_blob|
For backward compatibility, this method can be used: >vim For backward compatibility, this method can be used: >vim
if type(myvar) == type(0) | endif if type(myvar) == type(0) | endif
if type(myvar) == type("") | endif if type(myvar) == type("") | endif

View File

@@ -979,12 +979,12 @@ vim.str_utf_end({str}, {index}) *vim.str_utf_end()*
Examples: >lua 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 -- Returns 0 because the index is pointing at the last byte of a character
vim.str_utf_end('æ', 2) 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) vim.str_utf_end('æ', 1)
< <
@@ -1016,7 +1016,7 @@ vim.str_utf_start({str}, {index}) *vim.str_utf_start()*
Examples: >lua 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 -- Returns 0 because the index is pointing at the first byte of a character
vim.str_utf_start('æ', 1) vim.str_utf_start('æ', 1)

View File

@@ -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") 'mousescroll' string (default "ver:3,hor:6")
global global
This option controls the number of lines / columns to scroll by when 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. scrolling with a mouse wheel (|scroll-mouse-wheel|). The option is
Each part consists of a direction and a count as follows: a comma-separated list. Each part consists of a direction and a count
as follows:
direction:count,direction:count direction:count,direction:count
Direction is one of either "hor" or "ver". "hor" controls horizontal Direction is one of either "hor" or "ver". "hor" controls horizontal
scrolling and "ver" controls vertical scrolling. Count sets the amount scrolling and "ver" controls vertical scrolling. Count sets the amount

View File

@@ -132,7 +132,7 @@ function vim.str_utf_pos(str) end
--- ---
--- Examples: --- Examples:
--- <pre>lua --- <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 --- -- Returns 0 because the index is pointing at the first byte of a character
--- vim.str_utf_start('æ', 1) --- vim.str_utf_start('æ', 1)
@@ -151,12 +151,12 @@ function vim.str_utf_start(str, index) end
--- ---
--- Examples: --- Examples:
--- <pre>lua --- <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 --- -- Returns 0 because the index is pointing at the last byte of a character
--- vim.str_utf_end('æ', 2) --- 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) --- vim.str_utf_end('æ', 1)
--- </pre> --- </pre>
--- ---

View File

@@ -4323,8 +4323,9 @@ vim.go.mousemoveevent = vim.o.mousemoveevent
vim.go.mousemev = vim.go.mousemoveevent vim.go.mousemev = vim.go.mousemoveevent
--- This option controls the number of lines / columns to scroll by when --- 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. --- scrolling with a mouse wheel (`scroll-mouse-wheel`). The option is
--- Each part consists of a direction and a count as follows: --- a comma-separated list. Each part consists of a direction and a count
--- as follows:
--- direction:count,direction:count --- direction:count,direction:count
--- Direction is one of either "hor" or "ver". "hor" controls horizontal --- Direction is one of either "hor" or "ver". "hor" controls horizontal
--- scrolling and "ver" controls vertical scrolling. Count sets the amount --- 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}. --- The result is a Number representing the type of {expr}.
--- Instead of using the number directly, it is better to use the --- Instead of using the number directly, it is better to use the
--- v:t_ variable that has the value: --- v:t_ variable that has the value:
--- Number: 0 (|v:t_number|) --- Number: 0 |v:t_number|
--- String: 1 (|v:t_string|) --- String: 1 |v:t_string|
--- Funcref: 2 (|v:t_func|) --- Funcref: 2 |v:t_func|
--- List: 3 (|v:t_list|) --- List: 3 |v:t_list|
--- Dictionary: 4 (|v:t_dict|) --- Dictionary: 4 |v:t_dict|
--- Float: 5 (|v:t_float|) --- Float: 5 |v:t_float|
--- Boolean: 6 (|v:true| and |v:false|) --- Boolean: 6 |v:t_bool| (|v:false| and |v:true|)
--- Null: 7 (|v:null|) --- Null: 7 (|v:null|)
--- Blob: 10 (|v:t_blob|) --- Blob: 10 |v:t_blob|
--- For backward compatibility, this method can be used: >vim --- For backward compatibility, this method can be used: >vim
--- if type(myvar) == type(0) | endif --- if type(myvar) == type(0) | endif
--- if type(myvar) == type("") | endif --- if type(myvar) == type("") | endif

View File

@@ -11824,15 +11824,15 @@ M.funcs = {
The result is a Number representing the type of {expr}. The result is a Number representing the type of {expr}.
Instead of using the number directly, it is better to use the Instead of using the number directly, it is better to use the
v:t_ variable that has the value: v:t_ variable that has the value:
Number: 0 (|v:t_number|) Number: 0 |v:t_number|
String: 1 (|v:t_string|) String: 1 |v:t_string|
Funcref: 2 (|v:t_func|) Funcref: 2 |v:t_func|
List: 3 (|v:t_list|) List: 3 |v:t_list|
Dictionary: 4 (|v:t_dict|) Dictionary: 4 |v:t_dict|
Float: 5 (|v:t_float|) Float: 5 |v:t_float|
Boolean: 6 (|v:true| and |v:false|) Boolean: 6 |v:t_bool| (|v:false| and |v:true|)
Null: 7 (|v:null|) Null: 7 (|v:null|)
Blob: 10 (|v:t_blob|) Blob: 10 |v:t_blob|
For backward compatibility, this method can be used: >vim For backward compatibility, this method can be used: >vim
if type(myvar) == type(0) | endif if type(myvar) == type(0) | endif
if type(myvar) == type("") | endif if type(myvar) == type("") | endif

View File

@@ -1411,7 +1411,6 @@ static int normal_check(VimState *state)
} }
quit_more = false; quit_more = false;
// it's not safe unless normal_check_safe_state() is called
state_no_longer_safe(NULL); state_no_longer_safe(NULL);
// If skip redraw is set (for ":" in wait_return()), don't redraw now. // If skip redraw is set (for ":" in wait_return()), don't redraw now.

View File

@@ -5500,8 +5500,9 @@ return {
defaults = { if_true = 'ver:3,hor:6' }, defaults = { if_true = 'ver:3,hor:6' },
desc = [=[ desc = [=[
This option controls the number of lines / columns to scroll by when 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. scrolling with a mouse wheel (|scroll-mouse-wheel|). The option is
Each part consists of a direction and a count as follows: a comma-separated list. Each part consists of a direction and a count
as follows:
direction:count,direction:count direction:count,direction:count
Direction is one of either "hor" or "ver". "hor" controls horizontal Direction is one of either "hor" or "ver". "hor" controls horizontal
scrolling and "ver" controls vertical scrolling. Count sets the amount scrolling and "ver" controls vertical scrolling. Count sets the amount

View File

@@ -726,7 +726,7 @@ void getvcols(win_T *wp, pos_T *pos1, pos_T *pos2, colnr_T *left, colnr_T *right
/// Functions calculating vertical size of text when displayed inside a window. /// Functions calculating vertical size of text when displayed inside a window.
/// Calls horizontal size functions defined above. /// Calls horizontal size functions defined above.
/// Check the there may be filler inlines anywhere in window "wp" /// Check if there may be filler inlines anywhere in window "wp".
bool win_may_fill(win_T *wp) bool win_may_fill(win_T *wp)
{ {
return (wp->w_p_diff && diffopt_filler()) || wp->w_buffer->b_virt_line_blocks; return (wp->w_p_diff && diffopt_filler()) || wp->w_buffer->b_virt_line_blocks;