search

google / vimdoc

Helpfile generation for vim
Apache License 2.0
291 stars 28 forks source link

Remove 'main file' requirement #24

Closed Soares closed 10 years ago

Soares commented 10 years ago

Vimdoc should be able to use global directives (@author, etc.) no matter where they should fine. (If there's a conflict, it should complain gracefully.)

dbarnett commented 10 years ago

One other catch: We implicitly promote the first or last block in the "main file" to the intro or about section, respectively. If we don't designate a "main file", we can't do that anymore. I'd be in favor of getting rid of the implicit section behavior, even though it's going to be annoying. Otherwise, we'll have to somehow make sure different files don't accidentally define conflicting intro sections and conflict with each other.

Soares commented 10 years ago

Yeah, +1 for getting rid of the implicit section behavior. We can just add @intro and @about without much trouble. There might already be machinery for complaining when different files have @statusline/@author/etc. that we can re-use, otherwise we should add such machinery.