google / google/vimdoc

Docs for plugin dir like "vim-SOMEPLUGIN" shouldn't silently include "vim-" prefix

Open
#91 0 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

If there's no plugin name declared in addon-info.json, vimdoc takes the name of the directory that contains the plugin as the plugin name. Often this directory will have a "vim-" prefix or some other variation on the plugin name, which usually should not be taken as the literal plugin name.

Vimdoc should either automatically drop known prefixes/suffixes like "vim-" (the same way maktaba does) or warn when it detects docs being generated for ambiguous plugin names.

Specifying a literal plugin name in addon-info.json should always get you exactly the name you specify with no errors or warnings.

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.