google / vimdoc

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

Functions/commands without descriptions completely missing from docs #64

Closed dbarnett closed 10 years ago

dbarnett commented 10 years ago

Functions and commands defined without description text show a warning like DocumentationWarning: Undocumented function Foo and aren't listed at all in the documentation, even if they're declared with a vimdoc comment block that explicitly lists them as @public and declares their signature with @usage. Granted, our warning indicates you shouldn't be doing that anyway, but it should either:

(And, FWIW, it's pretty opinionated of us to issue a warning for perfectly valid vimdoc; some really simple functions/commands may be self-explanatory enough from the arg names and just not need prose.)