vimdoc

vimdoc copied to clipboard

Use library for vimscript parsing instead of regexes

3

Per neovim/neovim#170 and https://neovim.io/doc/user/api.html#nvim_parse_expression(), libnvim now offers an API to parse vimscript syntax to an AST. We should give it a shot hooking that up to vimdoc and see if...

dbarnett

Add = sign to every line

2

ghost

Don't split backtick-quoted strings in paragraphs

6

Vim help syntax recognizes backtick-quoted strings as short code snippets. It doesn't show the backticks, and applies a highlight group. However, it appears to only recognize these quotes if they...

flwyd

Handle 'exception' types better

2

The code to check whether a function is an exception (in output.py HelpFile.WriteChunk) is hacky and brittle. We should generalize the mechanism. (The same hack is used in block.py Block.Close,...

Soares

Support default argument values

1

Vim 8.1.1310 added default values for function arguments, e.g. ```vim function Greet(greeting = 'hello') echo a:greeting 'world' endfunction ``` `vimdoc` currently parses this as a two-arg function with parameters `greeting`...

flwyd

If a `.vim` script contains a line continuation comment (`:help line-continuation-comment`, [introduced in Vim 8.1.0369](https://github.com/vim/vim/commit/67f8ab829911c7901c534ef2bf19cc34b622936f)), `vimdoc` fails to parse it with an error like ``` Traceback (most recent call last):...

flwyd

For plugins with a lot of functions or flags, there doesn't seem to be a directive to tell vimdoc to group item docs into a subsection. For instance if I...

dbarnett

Don't wrap long lines in literal blocks

2

Hi, thanks for this tool :) We are trying to include some example mappings in the documentation: ``` " Phpactor does not assume any mappings automatically, the following mappings "...

dantleech

Vimdoc refuses to generate helpfile for dict-functions that are not autoload

5

While vimdoc supports the notation of ``@dict``, which works with one form of dictionary functions, it skips all the functions that are not autoload. For example, while you can use...

cgsdfc

Add a markdown output mode

1

vimdoc should be able to generate markdown output as an alternative to vim helpfile syntax. We'll have to figure out how relative links can work first. Note: These wouldn't be...

dbarnett