vimdoc
vimdoc copied to clipboard
google
Helpfile generation for vim
According to , I write this hook and test it can work for me: `.pre-commit-config.yaml` ```yaml - repo: https://github.com/Freed-Wu/vimdoc rev: master hooks: - id: vimdoc ``` I advice to publish...
```vim "" " foobar call g:foobar#utils#plugin.Flag('g:foobar', \ get(s:foobar, 0, '') \ ) ``` It can work: ``` *foobar:g:foobar* foobar Default: get(s:foobar, 0, '') ` ``` However, the default of nested...
``` ❯ vimdoc . /usr/lib/python3.10/site-packages/vimdoc/block.py:224: DocumentationWarning: Documentation claims optional parameters that function A does not accept. warnings.warn( Traceback (most recent call last): File "/usr/bin/vimdoc", line 5, in vimdoc.__main__.main() File "/usr/lib/python3.10/site-packages/vimdoc/__main__.py",...
``` ❯ vimdoc usage: vimdoc [-h] [--version] PLUGIN vimdoc: error: the following arguments are required: PLUGIN ❯ vimdoc . ``` Why not let default plugin is `.`? Thanks.
is it possible to add `*.lua` support? for example: `lua/plugin_name/init.lua` ```lua ---- -- This is my function. It does different things to the {required} argument, -- depending upon the [optional]...
I noticed vimdoc outputs some ugly extra blank lines between consecutive vimscript examples if you have something like: ```vim "" " Example: > " call Foo() " < > "...
We should reevaluate: What types of packages should we have for each release under https://github.com/google/vimdoc/releases, and how should we build them? Why: I ran into a few little snags building...
> Note: I'm not yet savvy enough with the source to sort-out why > `self.locals.get` is returning `None` instead of an empty string. > > But this seems to work...
These changes _should_ prevent breaking _long words_, such as URLs or function names... But detecting when within a code-block/example is, for now, an exercise I've been advised to be a...