google / google/vimdoc

Provide mechanism for doc blocks outside vimscript files

Open
#36 3 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
306
Forks
30
PR merge metrics
No merged PRs in 30d

Description

For some plugins, there's no natural place to put doc comments like `@section` blocks to control vimdoc output, so we've resorted to a convention of adding empty `plugin/doc.vim` files purely to contain the doc comments. This is a little unintuitive and adds unnecessary runtime overhead.

We should investigate an alternative mechanism to define doc sections in a separate non-vimscript file.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.