google / vimdoc

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

Fix implicit @section id, document @subsection and @backmatter #62

Closed dbarnett closed 10 years ago

dbarnett commented 10 years ago

Allow omitting the id from @section to use a lowercased version of the name. Prevents getting a None id causing a NeglectedSections error. Fixes #13.

Also adds missing documentation for @subsection and @backmatter. Fixes #55.

dbarnett commented 10 years ago

Considering the single-arg version is currently broken and nobody's successfully using it yet, if we want different behavior, now is the time to come up with it. I almost feel like it should be @section id[, name] or @section [name, ]id, so you could have @section intro as shorthand for @section Introduction, intro. OTOH, there's more room for error translating id->name (might end up with weird-looking names).

xanderman commented 10 years ago

LGTM