search

guns / vim-sexp

Precision Editing for S-expressions
MIT License
612 stars 33 forks source link

Respect "local-additions" convention in magic first line of vim-sexp.txt #3

Closed glts closed 10 years ago

glts commented 10 years ago

@guns, when I consult the table of contents at :h local-additions vim-sexp isn't there. This is because vim-sexp does not respect the convention documented at :h write-local-help: The first line of a plugin doc is magic, and the proper format is

*myplugin.txt*<Tab>This is the tagline for my plugin

In practice, hardly anybody uses <Tab>. (I do: to make sure "the entries line up nicely".)

I have a creeping feeling that I'm turning into the GitHub resident respect-local-additions-magic-first-line-of-doc.txt zealot, but hey, we do what we do best, don't we? Feel free to disregard this end of the year (at least on my end) trifle.

Looking forward to using vim-sexp in the new year, nice work!

guns commented 10 years ago

Ah, I was totally unaware of this convention. It's strange to say, but it's exciting to know that there always seems to be something new to learn in Vim.

GitHub resident respect-local-additions-magic-first-line-of-doc.txt zealot

:)

I can see Vim continue to flourish for the next 20 years, but much of that will depend on the quality and composability of Vim plugins. So thank you, and please continue!