docs: fix typos (#22353)

This commit is contained in:
zeertzjq 2023-02-22 00:07:26 +08:00 committed by GitHub
parent ee26b227e1
commit 344a1ee8e6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
21 changed files with 61 additions and 61 deletions

View File

@ -2644,7 +2644,7 @@ nvim_buf_set_extmark({buffer}, {ns_id}, {line}, {col}, {*opts})
buffer.
• right_gravity : boolean that indicates the direction the
extmark will be shifted in when new text is inserted (true
for right, false for left). defaults to true.
for right, false for left). Defaults to true.
• end_right_gravity : boolean that indicates the direction
the extmark end position (if it exists) will be shifted in
when new text is inserted (true for right, false for

View File

@ -426,7 +426,7 @@ ColorSchemePre Before loading a color scheme. |:colorscheme|
Useful to setup removing things added by a
color scheme, before another one is loaded.
CompleteChanged *CompleteChanged*
CompleteChanged *CompleteChanged*
After each time the Insert mode completion
menu changed. Not fired on popup menu hide,
use |CompleteDonePre| or |CompleteDone| for

View File

@ -1055,7 +1055,7 @@ chansend({id}, {data}) *chansend()*
newlines in an item will be sent as NUL. To send a final
newline, include a final empty string. Example: >
:call chansend(id, ["abc", "123\n456", ""])
< will send "abc<NL>123<NUL>456<NL>".
< will send "abc<NL>123<NUL>456<NL>".
chansend() writes raw data, not RPC messages. If the channel
was created with `"rpc":v:true` then the channel expects RPC
@ -4846,7 +4846,7 @@ maparg({name} [, {mode} [, {abbr} [, {dict}]]]) *maparg()*
"lhs" The {lhs} of the mapping as it would be typed
"lhsraw" The {lhs} of the mapping as raw bytes
"lhsrawalt" The {lhs} of the mapping as raw bytes, alternate
form, only present when it differs from "lhsraw"
form, only present when it differs from "lhsraw"
"rhs" The {rhs} of the mapping as typed.
"silent" 1 for a |:map-silent| mapping, else 0.
"noremap" 1 if the {rhs} of the mapping is not remappable.

View File

@ -113,14 +113,14 @@ LSP FUNCTIONS
- *vim.lsp.util.set_qflist()* Use |setqflist()| instead.
- *vim.lsp.util.set_loclist()* Use |setloclist()| instead.
- *vim.lsp.buf_get_clients()* Use |vim.lsp.get_active_clients()| with
{buffer = bufnr} instead.
{buffer = bufnr} instead.
- *vim.lsp.buf.formatting()* Use |vim.lsp.buf.format()| with
{async = true} instead.
- *vim.lsp.buf.range_formatting()* Use |vim.lsp.formatexpr()|
or |vim.lsp.buf.format()| instead.
LUA
- *vim.register_keystroke_callback()* Use |vim.on_key()| instead.
- *vim.register_keystroke_callback()* Use |vim.on_key()| instead.
NORMAL COMMANDS
- *]f* *[f* Same as "gf".

View File

@ -81,7 +81,7 @@ include the kitchen sink... but it's good for plumbing."
Developer guidelines *dev-guidelines*
PROVIDERS *dev-provider*
PROVIDERS *dev-provider*
A primary goal of Nvim is to allow extension of the editor without special
knowledge in the core. Some core functions are delegated to "providers"
@ -391,7 +391,7 @@ API client implementation guidelines ~
https://github.com/msgpack-rpc/msgpack-rpc
EXTERNAL UI *dev-ui*
EXTERNAL UI *dev-ui*
External UIs should be aware of the |api-contract|. In particular, future
versions of Nvim may add new items to existing events. The API is strongly

View File

@ -1817,17 +1817,17 @@ v:event Dictionary of event data for the current |autocommand|. Valid
completed_item Current selected complete item on
|CompleteChanged|, Is `{}` when no complete
item selected.
height Height of popup menu on |CompleteChanged|
width width of popup menu on |CompleteChanged|
row Row count of popup menu on |CompleteChanged|,
height Height of popup menu on |CompleteChanged|
width width of popup menu on |CompleteChanged|
row Row count of popup menu on |CompleteChanged|,
relative to screen.
col Col count of popup menu on |CompleteChanged|,
col Col count of popup menu on |CompleteChanged|,
relative to screen.
size Total number of completion items on
size Total number of completion items on
|CompleteChanged|.
scrollbar Is |v:true| if popup menu have scrollbar, or
scrollbar Is |v:true| if popup menu have scrollbar, or
|v:false| if not.
changed_window Is |v:true| if the event fired while
changed_window Is |v:true| if the event fired while
changing window (or tab) on |DirChanged|.
status Job status or exit code, -1 means "unknown". |TermClose|
@ -2668,8 +2668,8 @@ text...
Example with [depth] 0: >
let mylist = [1, 2, 3]
lockvar 0 mylist
let mylist[0] = 77 " OK
call add(mylist, 4] " OK
let mylist[0] = 77 " OK
call add(mylist, 4] " OK
let mylist = [7, 8, 9] " Error!
< *E743*
For unlimited depth use [!] and omit [depth].

View File

@ -120,15 +120,15 @@ PROGRAMMING LANGUAGE SUPPORT
|lsp| Language Server Protocol (LSP)
|diagnostic-api| Diagnostic framework
|treesitter| Incremental syntax parsing
|indent.txt| automatic indenting for C and other languages
|indent.txt| automatic indenting for C and other languages
|syntax| syntax highlighting
|filetype| Settings for specific types of files
|quickfix| Commands for a quick edit-compile-fix cycle
|ft_ada.txt| Ada filetype plugin
|ft_ps1.txt| PowerShell filetype plugin
|ft_raku.txt| Raku filetype plugin
|ft_rust.txt| Rust filetype plugin
|ft_sql.txt| SQL filetype plugin
|ft_ada.txt| Ada filetype plugin
|ft_ps1.txt| PowerShell filetype plugin
|ft_raku.txt| Raku filetype plugin
|ft_rust.txt| Rust filetype plugin
|ft_sql.txt| SQL filetype plugin
------------------------------------------------------------------------------
UI
@ -172,14 +172,14 @@ DEVELOPING NVIM
*standard-plugin-list*
Standard plugins ~
|matchit.txt| Extended |%| matching
|pi_gzip.txt| Reading and writing compressed files
|pi_health.txt| Healthcheck framework
|pi_msgpack.txt| msgpack utilities
|pi_netrw.txt| Reading and writing files over a network
|pi_paren.txt| Highlight matching parens
|pi_spec.txt| Filetype plugin to work with rpm spec files
|pi_tar.txt| Tar file explorer
|pi_zip.txt| Zip archive explorer
|pi_gzip.txt| Reading and writing compressed files
|pi_health.txt| Healthcheck framework
|pi_msgpack.txt| msgpack utilities
|pi_netrw.txt| Reading and writing files over a network
|pi_paren.txt| Highlight matching parens
|pi_spec.txt| Filetype plugin to work with rpm spec files
|pi_tar.txt| Tar file explorer
|pi_zip.txt| Zip archive explorer
LOCAL ADDITIONS: *local-additions*

View File

@ -116,7 +116,7 @@ Overview >
VIM::SetOption("ai") # sets a vim option
$nbuf = VIM::Buffers() # returns the number of buffers
@buflist = VIM::Buffers() # returns array of all buffers
$mybuf = (VIM::Buffers('a.c'))[0] # returns buffer object for 'a.c'
$mybuf = (VIM::Buffers('a.c'))[0] # returns buffer object for 'a.c'
@winlist = VIM::Windows() # returns array of all windows
$nwin = VIM::Windows() # returns the number of windows
($success, $v) = VIM::Eval('&path') # $v: option 'path', $success: 1

View File

@ -358,7 +358,7 @@ notation meaning equivalent decimal value(s) ~
<kOrigin> keypad origin (middle) *keypad-origin*
<kPageUp> keypad page-up (upper right) *keypad-page-up*
<kPageDown> keypad page-down (lower right) *keypad-page-down*
<kDel> keypad delete *keypad-delete*
<kDel> keypad delete *keypad-delete*
<kPlus> keypad + *keypad-plus*
<kMinus> keypad - *keypad-minus*
<kMultiply> keypad * *keypad-multiply*

View File

@ -589,7 +589,7 @@ i( *vib* *v_ib* *v_i(* *ib*
ib "inner block", select [count] blocks, from "[count] [("
to the matching ')', excluding the '(' and ')' (see
|[(|). If the cursor is not inside a () block, then
find the next "(".
find the next "(".
When used in Visual mode it is made charwise.
a> *v_a>* *v_a<* *a>* *a<*

View File

@ -239,7 +239,7 @@ gdb window and use a "print" command, e.g.: >
print *eap
If mouse pointer movements are working, Vim will also show a balloon when the
mouse rests on text that can be evaluated by gdb.
You can also use the "K" mapping that will either use neovim floating windows
You can also use the "K" mapping that will either use Nvim floating windows
if available to show the results or print below the status bar.
Now go back to the source window and put the cursor on the first line after
@ -428,14 +428,14 @@ If the command needs an argument use a List: >vim
If there is no g:termdebug_config you can use: >vim
let g:termdebugger = ['rr', 'replay', '--']
To not use neovim floating windows for previewing variable evaluation, set the
To not use Nvim floating windows for previewing variable evaluation, set the
`g:termdebug_useFloatingHover` variable like this: >vim
let g:termdebug_useFloatingHover = 0
If you are a mouse person, you can also define a mapping using your right
click to one of the terminal command like evaluate the variable under the
cursor: >vim
nnoremap <RightMouse> :Evaluate<CR>
nnoremap <RightMouse> :Evaluate<CR>
or set/unset a breakpoint: >vim
nnoremap <RightMouse> :Break<CR>

View File

@ -4,7 +4,7 @@
NVIM REFERENCE MANUAL by Thiago de Arruda
Providers *provider*
Providers *provider*
Nvim delegates some features to dynamic "providers". This document describes
the providers and how to install them.
@ -82,7 +82,7 @@ The last command reports the interpreter path, add it to your init.vim: >vim
See also: https://github.com/zchee/deoplete-jedi/wiki/Setting-up-Python-for-Neovim
==============================================================================
Ruby integration *provider-ruby*
Ruby integration *provider-ruby*
Nvim supports Ruby |remote-plugin|s and the Vim legacy |ruby-vim| interface
(which is itself implemented as a Nvim remote-plugin).
@ -169,7 +169,7 @@ can be slow. To avoid this, set g:node_host_prog to the host path: >vim
let g:node_host_prog = '/usr/local/bin/neovim-node-host'
<
==============================================================================
Clipboard integration *provider-clipboard* *clipboard*
Clipboard integration *provider-clipboard* *clipboard*
Nvim has no direct connection to the system clipboard. Instead it depends on
a |provider| which transparently uses shell commands to communicate with the
@ -255,7 +255,7 @@ For Windows WSL, try this g:clipboard definition:
\ }
==============================================================================
Paste *provider-paste* *paste*
Paste *provider-paste* *paste*
"Paste" is a separate concept from |clipboard|: paste means "dump a bunch of
text to the editor", whereas clipboard provides features like |quote+| to get

View File

@ -4,7 +4,7 @@
NVIM REFERENCE MANUAL by Thiago de Arruda
Nvim support for remote plugins *remote-plugin*
Nvim support for remote plugins *remote-plugin*
Type |gO| to see the table of contents.

View File

@ -368,7 +368,7 @@ argument.
-W {scriptout} Like -w, but do not append, overwrite an existing file.
*--api-info*
--api-info Print msgpack-encoded |api-metadata| and exit.
--api-info Print msgpack-encoded |api-metadata| and exit.
*--embed*
--embed Use stdin/stdout as a msgpack-RPC channel, so applications can
@ -392,7 +392,7 @@ argument.
< See also: |ui-startup| |channel-stdio|
*--headless*
--headless Start without UI, and do not wait for `nvim_ui_attach`. The
--headless Start without UI, and do not wait for `nvim_ui_attach`. The
builtin TUI is not used, so stdio works as an arbitrary
communication channel. |channel-stdio|

View File

@ -53,11 +53,11 @@ with these (optional) keys:
- `term_name` Sets the name of the terminal 'term'.
- `term_colors` Sets the number of supported colors 't_Co'.
- `term_background` Sets the default value of 'background'.
- `stdin_fd` Read buffer from `fd` as if it was a stdin pipe
This option can only used by |--embed| ui,
see |ui-startup-stdin|.
`stdin_tty` Tells if `stdin` is a `tty` or not.
`stdout_tty` Tells if `stdout` is a `tty` or not.
- `stdin_fd` Read buffer from `fd` as if it was a stdin pipe.
This option can only used by |--embed| ui on startup.
See |ui-startup-stdin|.
- `stdin_tty` Tells if `stdin` is a `tty` or not.
- `stdout_tty` Tells if `stdout` is a `tty` or not.
Specifying an unknown option is an error; UIs can check the |api-metadata|
`ui_options` key for supported options.
@ -154,11 +154,11 @@ procedure:
An UI can support the native read from stdin feature as invoked with
`command | nvim -` for the builtin TUI. |--|
The embedding process can detect that its stdin is open to a file which
not is a terminal, just like nvim does. It then needs to forward this fd
not is a terminal, just like Nvim does. It then needs to forward this fd
to Nvim. As fd=0 is already is used to send rpc data from the embedder to
Nvim, it needs to use some other file descriptor, like fd=3 or higher.
Then, `stdin_fd` option should be passed to `nvim_ui_attach` and nvim will
Then, `stdin_fd` option should be passed to `nvim_ui_attach` and Nvim will
implicitly read it as a buffer. This option can only be used when Nvim is
launched with `--embed` option, as described above.
@ -356,8 +356,8 @@ numerical highlight ids to the actual attributes.
The bulitin highlight group `name` was set to use the attributes `hl_id`
defined by a previous `hl_attr_define` call. This event is not needed
to render the grids which use attribute ids directly, but is useful
for an UI who want to render its own elements with consistent
highlighting. For instance an UI using |ui-popupmenu| events, might
for a UI who want to render its own elements with consistent
highlighting. For instance a UI using |ui-popupmenu| events, might
use the |hl-Pmenu| family of builtin highlights.
*ui-event-grid_line*
@ -532,7 +532,7 @@ is not active. New UIs should implement |ui-linegrid| instead.
+-------------------------+
<
==============================================================================
Detailed highlight state Extension *ui-hlstate*
Detailed highlight state Extension *ui-hlstate*
Activated by the `ext_hlstate` |ui-option|.
Activates |ui-linegrid| implicitly.
@ -566,7 +566,7 @@ highlight group is cleared, so `ui_name` can always be used to reliably identify
screen elements, even if no attributes have been applied.
==============================================================================
Multigrid Events *ui-multigrid*
Multigrid Events *ui-multigrid*
Activated by the `ext_multigrid` |ui-option|.
Activates |ui-linegrid| implicitly.

View File

@ -473,7 +473,7 @@ will be no "Last set" message. When it was defined while executing a function,
user command or autocommand, the script in which it was defined is reported.
*K*
[count]K Runs the program given by 'keywordprg' to lookup the
[count]K Runs the program given by 'keywordprg' to lookup the
|word| (defined by 'iskeyword') under or right of the
cursor. Default is "man". Works like this: >
:tabnew | terminal {program} {keyword}

View File

@ -223,7 +223,7 @@ CTRL-W ^ Split the current window in two and edit the alternate file.
CTRL-W ge *CTRL-W_ge*
Detach the current window as an external window.
Only available when using an UI with |ui-multigrid| support.
Only available when using a UI with |ui-multigrid| support.
Note that the 'splitbelow' and 'splitright' options influence where a new
window will appear.

View File

@ -445,7 +445,7 @@ Array nvim_buf_get_extmarks(Buffer buffer, Integer ns_id, Object start, Object e
/// buffer.
/// - right_gravity : boolean that indicates the direction
/// the extmark will be shifted in when new text is inserted
/// (true for right, false for left). defaults to true.
/// (true for right, false for left). Defaults to true.
/// - end_right_gravity : boolean that indicates the direction
/// the extmark end position (if it exists) will be shifted
/// in when new text is inserted (true for right, false

View File

@ -382,7 +382,7 @@ static void ui_set_option(UI *ui, bool init, String name, Object value, Error *e
});
bool boolval = value.data.boolean;
if (!init && i == kUILinegrid && boolval != ui->ui_ext[i]) {
// There shouldn't be a reason for an UI to do this ever
// There shouldn't be a reason for a UI to do this ever
// so explicitly don't support this.
api_set_error(err, kErrorTypeValidation, "ext_linegrid option cannot be changed");
}

View File

@ -186,7 +186,7 @@ static void tinput_done_event(void **argv)
os_exit(1);
}
/// Send all pending input to Nvim server.
/// Send all pending input in key buffer to Nvim server.
static void tinput_flush(TermInput *input)
{
if (input->paste) { // produce exactly one paste event

View File

@ -153,7 +153,7 @@ UIClientHandler ui_client_get_redraw_handler(const char *name, size_t name_len,
/// Placeholder for _sync_ requests with 'redraw' method name
///
/// async 'redraw' events, which are expected when nvim acts as an ui client.
/// async 'redraw' events, which are expected when nvim acts as a ui client.
/// get handled in msgpack_rpc/unpacker.c and directly dispatched to handlers
/// of specific ui events, like ui_client_event_grid_resize and so on.
Object handle_ui_client_redraw(uint64_t channel_id, Array args, Arena *arena, Error *error)