small vimdoc fixes

pull/81/head
Timothée Sterle 3 years ago
parent 87d42f38b0
commit a74f03fadb
No known key found for this signature in database
GPG Key ID: 136D558122196ED5

@ -62,7 +62,7 @@ A few tutorials have already been written to help people write plugins in Lua. S
Neovim supports loading an `init.lua` file for configuration instead of the usual `init.vim`. Neovim supports loading an `init.lua` file for configuration instead of the usual `init.vim`.
Note: `init.lua` is of course *completely* optional. Support for `init.vim` is not going away and is still a valid option for configuration. Do keep in mind that some features are not 100% exposed to Lua yet. Note: `init.lua` is of course _completely_ optional. Support for `init.vim` is not going away and is still a valid option for configuration. Do keep in mind that some features are not 100% exposed to Lua yet.
See also: See also:
- [`:help config`](https://neovim.io/doc/user/starting.html#config) - [`:help config`](https://neovim.io/doc/user/starting.html#config)
@ -475,7 +475,7 @@ true)
print(result) -- 'hello world' print(result) -- 'hello world'
``` ```
**TODO**: The docs say that script-scope (`s:`) is supported, but running this snippet with a script-scoped variable throws an error. Why? **TODO**: the docs say that script-scope (`s:`) is supported, but running this snippet with a script-scoped variable throws an error. Why?
### vim.api.nvim_command() ### vim.api.nvim_command()

@ -94,7 +94,7 @@ init.lua~
Neovim supports loading an `init.lua` file for configuration instead of Neovim supports loading an `init.lua` file for configuration instead of
the usual `init.vim`. the usual `init.vim`.
Note: `init.lua` is of course *completely* optional. Support Note: `init.lua` is of course _completely_ optional. Support
for `init.vim` is not going away and is still a valid option for for `init.vim` is not going away and is still a valid option for
configuration. Do keep in mind that some features are not 100% exposed configuration. Do keep in mind that some features are not 100% exposed
to Lua yet. to Lua yet.
@ -548,8 +548,8 @@ It is the Lua equivalent of the `luaeval()` function in Vimscript
print(vim.api.nvim_eval('v:null')) -- nil print(vim.api.nvim_eval('v:null')) -- nil
< <
*Todo tasks: is it possible for `vim.api.nvim_eval()` to return *Todo is it possible for `vim.api.nvim_eval()` to return a
a `funcref`? `funcref`?
Caveats~ Caveats~
@ -579,7 +579,7 @@ store the output in a variable, for example).
print(result) -- 'hello world' print(result) -- 'hello world'
< <
*Todo tasks: The docs say that script-scope (`s:`) is supported, *Todo the docs say that script-scope (`s:`) is supported,
but running this snippet with a script-scoped variable throws but running this snippet with a script-scoped variable throws
an error. Why? an error. Why?

@ -29,7 +29,7 @@ s/\[`\(.*\)`\](.*)/|\1|/
} }
# Todos # Todos
s/\*\*TODO\*\*:/\t*Todo\ttasks:/g s/\*\*TODO\*\*: /\t*Todo\t/g
# Warnings # Warnings
s/\*\*\(WARNING\)\*\*/\1/ s/\*\*\(WARNING\)\*\*/\1/

Loading…
Cancel
Save