Skip to content
This repository has been archived by the owner on Feb 25, 2022. It is now read-only.

Improve reporting of invalid API defition in JSON file #39

Open
v9n opened this issue Sep 2, 2014 · 1 comment
Open

Improve reporting of invalid API defition in JSON file #39

v9n opened this issue Sep 2, 2014 · 1 comment

Comments

@v9n
Copy link

v9n commented Sep 2, 2014

When something is wrong in doc.json

  • missing class def
  • missing param

I got some general error like:

template: php/readme.md:188:20: executing "php/readme.md" at <index $data.Doc $cla...>: error calling index: index of nil pointer

or

template: php/readme.md:170:6: executing "php/readme.md" at <index $data.Doc . "t...>: error calling index: index of nil pointer

Should we improve this error message? Like missing definition of class, or missing param def of method...

@pksunkara
Copy link
Owner

Yes, this definitely needs to be improved. If you look at the code, there's Check.... functions where the checking for missing things needs to go.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants