diff --git a/README.md b/README.md index 727efbc..767a9ba 100644 --- a/README.md +++ b/README.md @@ -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`. -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: - [`:help config`](https://neovim.io/doc/user/starting.html#config) @@ -475,7 +475,7 @@ true) 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() diff --git a/doc/nvim-lua-guide.txt b/doc/nvim-lua-guide.txt index 171ebfe..b4f7070 100644 --- a/doc/nvim-lua-guide.txt +++ b/doc/nvim-lua-guide.txt @@ -94,7 +94,7 @@ init.lua~ Neovim supports loading an `init.lua` file for configuration instead of 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 configuration. Do keep in mind that some features are not 100% exposed 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 < - *Todo tasks: is it possible for `vim.api.nvim_eval()` to return - a `funcref`? + *Todo is it possible for `vim.api.nvim_eval()` to return a + `funcref`? Caveats~ @@ -579,7 +579,7 @@ store the output in a variable, for example). 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 an error. Why? diff --git a/scripts/to_vimdoc.sed b/scripts/to_vimdoc.sed index 6ae40ea..5b8ceba 100755 --- a/scripts/to_vimdoc.sed +++ b/scripts/to_vimdoc.sed @@ -29,7 +29,7 @@ s/\[`\(.*\)`\](.*)/|\1|/ } # Todos -s/\*\*TODO\*\*:/\t*Todo\ttasks:/g +s/\*\*TODO\*\*: /\t*Todo\t/g # Warnings s/\*\*\(WARNING\)\*\*/\1/