Skip to content

Update doc to suggest using () instead of ; when using <Plug> mappings#20351

Closed
Aster89 wants to merge 1 commit into
vim:masterfrom
Aster89:improve-doc
Closed

Update doc to suggest using () instead of ; when using <Plug> mappings#20351
Aster89 wants to merge 1 commit into
vim:masterfrom
Aster89:improve-doc

Conversation

@Aster89
Copy link
Copy Markdown
Contributor

@Aster89 Aster89 commented May 28, 2026

I'm attempting to gather consensus and, if gathered, apply an improvement to the doc as regards the suggestion - found at :help using-<Plug> - of using the ; terminator; the doc should instead suggest to use (-) delimiters.

The matter surfaced on vi.stackexchange, see @romainl 's answer and N.W.'s comment.

@chrisbra
Copy link
Copy Markdown
Member

I think this makes sense, thanks

@romainl
Copy link
Copy Markdown
Contributor

romainl commented May 28, 2026

What I meant to say in the linked answer was that what comes after <Plug> is 100% arbitrary. It doesn't have to be in PascalCase. It doesn't have to end with a "terminator". It doesn't have to be wrapped in parentheses or anything. It doesn't have to be legible or short or make any kind of sense. It's just whatever the person who create that mapping came up with.

Using a specific "terminator", wrapping the name in a pair or characters, using PascalCase to separate the plugin name from the functionality… it's all just tricks.

And I think that the doc could be a little bit more transparent about that.

@chrisbra
Copy link
Copy Markdown
Member

I made it a bit more clear

@chrisbra chrisbra closed this in 9d5a20e May 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants