google / vimdoc

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

Remove automatic blocks at start-of-file #42

Closed dbarnett closed 10 years ago

dbarnett commented 10 years ago

vimdoc tries to parse the first comment in a file as a vimdoc block even if it doesn't have a comment leader. This makes much less sense after the removal of implicit sections (#40).

We should remove the auto vimdoc block behavior in favor of explicit vimdoc leaders. But first, we'll want to fix the parsing problems at start-of-file (#20) so people can switch to the explicit syntax and issue warnings for implicit syntax so people know they're depending on behavior that's about to change.

dbarnett commented 10 years ago

Actually, warning might be a pain since the behavior is triggered for a lot of comments that don't ultimately end up in the docs anyway, and warning only for affected cases would be awkward since the behavior is implemented in the parser. I guess folks will just have to pay attention to their diffs when running vimdoc.