Open wsdjeg opened 1 year ago
It's possible, but I'm not very familiar yet with how neovim hooks into lua and namespaces it. Any good examples you could point to?
Ideally I'd want to see (a) the lua signatures/definitions, (b) the usage docs for them, and (c) some manually-written vim helpdocs for them that you'd be looking to automatically generate.
If it's anything like vim's python support, I haven't considered that worth generating docs for those pieces because I wouldn't ask users in the plugin instructions to call python directly w/o a vim wrapper, or have python deps between plugins. But the shape of the situation might be a little different with neovim/lua, so I'm interested to see examples.
Hi:, here is some example meybe help:
let g:foo = 123
, It is vim.g.foo = 123
viml
"" " here is doc let g:foo = 123
lua:
-- here is doc vim.g.foo = 123
function!
command in luavimL
"" " here is doc for function function! hello#hello() endfunction
there is no :command
in lua too.
@section and @parentsection should work well in lua, just need to check if the comment start with:
vim: " @section xxx
lua: -- @section xxx
BTW, we should ignore lsp hover doc. all of them start with ---
is it possible to add
*.lua
support?for example:
lua/plugin_name/init.lua