plenary.nvim
plenary.nvim copied to clipboard
nvim-lua
Documentation for the async module
On the back of https://github.com/lewis6991/gitsigns.nvim/pull/287, I think it would be quite valuable at this point for some proper documentation to be written for the async module.
Personally I would prefer that this documentation was provided in vimdoc format (despite how much we all dislike the format itself) because it is very easy to look up while developing plugins. Obviously this doesn't restrict to providing markdown style docs too.
Yeah, we can add some documentation for it definitely. I would prefer to use it doing the docgen style we've used for telescope and some other projects, but I haven't had time yet (and it's also hard to both iterate on API and have no version in plugins :laughing: ). But we can probably add something for it soon.
I would prefer to use it doing the docgen style we've used for telescope and some other projects
Is that at all documented and/or easy to use? For gitsigns I've been maintaining docs manually.
https://github.com/tjdevries/tree-sitter-lua/blob/master/HOWTO.md
And then in telescope: https://github.com/nvim-telescope/telescope.nvim/blob/master/scripts/gendocs.lua
(this is being actively worked on, we have some weird grammar bugs occasionally which i'm working on tracking down)
I would like to try and help with the documentation of plenary using docgen. Is there maybe some module you would recommed as a starting point? Or maybe any suggestion?
