mirror of
https://github.com/neovim/neovim.git
synced 2025-09-05 19:08:15 +00:00
doc
vim-patch:8.0.1206: no autocmd for entering or leaving the command line
(commit a4f6cec7a3
)
NA patches:
vim-patch:8.0.0320: warning for unused variable with small build
This commit is contained in:
@@ -174,7 +174,7 @@ function! s:check_terminal() abort
|
||||
\ .(empty(kbs_entry) ? '? (not found)' : kdch1_entry))
|
||||
endif
|
||||
for env_var in ['XTERM_VERSION', 'VTE_VERSION', 'TERM_PROGRAM', 'COLORTERM', 'SSH_TTY']
|
||||
if !exists('$'.env_var)
|
||||
if exists('$'.env_var)
|
||||
call health#report_info(printf("$%s='%s'", env_var, eval('$'.env_var)))
|
||||
endif
|
||||
endfor
|
||||
|
@@ -512,27 +512,27 @@ nvim_parse_expression({expr}, {flags}, {highlight})
|
||||
[start_col, end_col)).
|
||||
|
||||
Return:~
|
||||
AST: top-level dictionary holds keys "error": Dictionary
|
||||
with error, present only if parser saw some error.
|
||||
Contains the following keys: "message": String, error
|
||||
message in printf format, translated. Must contain exactly
|
||||
one "%.*s". "arg": String, error message argument. "len":
|
||||
Amount of bytes successfully parsed. With flags equal to
|
||||
"" that should be equal to the length of expr string.
|
||||
@note: “Sucessfully parsed” here means “participated in
|
||||
AST creation”, not “till the first error”. "ast": AST,
|
||||
either nil or a dictionary with these keys: "type": node
|
||||
type, one of the value names from ExprASTNodeType
|
||||
stringified without "kExprNode" prefix. "start": a pair
|
||||
[line, column] describing where node is “started” where
|
||||
"line" is always 0 (will not be 0 if you will be using
|
||||
nvim_parse_viml() on e.g. ":let", but that is not present
|
||||
yet). Both elements are Integers. "len": “length” of the
|
||||
node. This and "start" are there for debugging purposes
|
||||
primary (debugging parser and providing debug
|
||||
information). "children": a list of nodes described in
|
||||
top/"ast". There always is zero, one or two children, key
|
||||
will not be present if node has no children. Maximum
|
||||
AST: top-level dictionary with these keys: "error":
|
||||
Dictionary with error, present only if parser saw some
|
||||
error. Contains the following keys: "message": String,
|
||||
error message in printf format, translated. Must contain
|
||||
exactly one "%.*s". "arg": String, error message argument.
|
||||
"len": Amount of bytes successfully parsed. With flags
|
||||
equal to "" that should be equal to the length of expr
|
||||
string. @note: “Sucessfully parsed” here means
|
||||
“participated in AST creation”, not “till the first
|
||||
error”. "ast": AST, either nil or a dictionary with these
|
||||
keys: "type": node type, one of the value names from
|
||||
ExprASTNodeType stringified without "kExprNode" prefix.
|
||||
"start": a pair [line, column] describing where node is
|
||||
“started” where "line" is always 0 (will not be 0 if you
|
||||
will be using nvim_parse_viml() on e.g. ":let", but that
|
||||
is not present yet). Both elements are Integers. "len":
|
||||
“length” of the node. This and "start" are there for
|
||||
debugging purposes primary (debugging parser and providing
|
||||
debug information). "children": a list of nodes described
|
||||
in top/"ast". There always is zero, one or two children,
|
||||
key will not be present if node has no children. Maximum
|
||||
number of children may be found in node_maxchildren array.
|
||||
Local values (present only for certain nodes): "scope": a
|
||||
single Integer, specifies scope for "Option" and
|
||||
@@ -1047,4 +1047,4 @@ nvim_ui_try_resize({width}, {height}) *nvim_ui_try_resize()*
|
||||
nvim_ui_set_option({name}, {value}) *nvim_ui_set_option()*
|
||||
TODO: Documentation
|
||||
|
||||
vim:tw=78:ts=8:ft=help:norl:
|
||||
vim:tw=78:ts=8:ft=help:norl:
|
||||
|
@@ -4,9 +4,9 @@
|
||||
NVIM REFERENCE MANUAL by Thiago de Arruda
|
||||
|
||||
|
||||
Nvim's facilities for async io *channel*
|
||||
Nvim asynchronous IO *channel*
|
||||
|
||||
Type <M-]> to see the table of contents.
|
||||
Type |gO| to see the table of contents.
|
||||
|
||||
==============================================================================
|
||||
1. Introduction *channel-intro*
|
||||
|
@@ -270,9 +270,9 @@ External UIs are expected to implement these common features:
|
||||
- Send the "super" key (Windows key, Apple key) as a |<D-| chord.
|
||||
|
||||
Implementation ~
|
||||
- Options can be monitored for changes by the |OptionSet| autocmd. E.g. if the
|
||||
user sets the 'guifont' option, this autocmd notifies channel 42: >
|
||||
autocmd OptionSet guifont call rpcnotify(42, 'option-changed', 'guifont', &guifont)
|
||||
- UI-related options ('guifont', 'ambiwidth', …) are published in the
|
||||
"option_set" |ui-global| event. The event is triggered when the UI first
|
||||
connects to Nvim and whenever an option is changed by the user or a plugin.
|
||||
|
||||
|
||||
vim:tw=78:ts=8:ft=help:norl:
|
||||
|
@@ -70,6 +70,7 @@ Providers
|
||||
Ruby plugins |provider-ruby|
|
||||
Shared data |shada|
|
||||
Embedded terminal |terminal|
|
||||
VimL parser |nvim_parse_expression()|
|
||||
XDG base directories |xdg|
|
||||
|
||||
USER EXPERIENCE ~
|
||||
|
@@ -478,7 +478,7 @@ def gen_docs(config):
|
||||
docs += '\n\n\n'
|
||||
|
||||
docs = docs.rstrip() + '\n\n'
|
||||
docs += ' vim:tw=78:ts=8:ft=help:norl:'
|
||||
docs += ' vim:tw=78:ts=8:ft=help:norl:\n'
|
||||
|
||||
doc_file = os.path.join(base_dir, 'runtime/doc', doc_filename)
|
||||
delete_lines_below(doc_file, section_start_token)
|
||||
|
@@ -929,7 +929,7 @@ typedef kvec_withinit_t(ExprASTConvStackItem, 16) ExprASTConvStack;
|
||||
/// starting column and ending column (latter exclusive:
|
||||
/// one should highlight region [start_col, end_col)).
|
||||
///
|
||||
/// @return AST: top-level dictionary holds keys
|
||||
/// @return AST: top-level dictionary with these keys:
|
||||
///
|
||||
/// "error": Dictionary with error, present only if parser saw some
|
||||
/// error. Contains the following keys:
|
||||
|
Reference in New Issue
Block a user