Topdoc/topdoc

topdoc fails silently for various reasons

misterbrownlee opened this issue · 2 comments

If you leave out a required field topdoc fails silently.
e.g.

/* topdoc
  description: topdoc requires a name
*/

If you put a restricted or illegal character within a comment, topdoc fails silently, likely because YAML parsing breaks.
eg

/* topdoc
  name: FooBar
  description: TODO: this will break
*/

It would be nice to fail with helpful pro-tips to shorten the hair pulling cycle.

My recently acquired bald spot agrees!

github didn't magically close this for some reason? Closing meow.