-
Notifications
You must be signed in to change notification settings - Fork 40
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Add tested_by functionality #54
Conversation
… of the emitted info.
Sorry about all the closing and reopening. Finally got the CLA check to pass. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Thanks, Brandon!
I am curious why yaml now has to know about json output? |
@jaredwy The goal of this is to be able to tag a particular API with the tests for it. That all works fine within the yaml. But then we also want to be able to parse out the test info to be able to generate coverage reports, etc. Ideally I wanted to just have hyde do:
However, the way hyde is currently architected, several things are intertwined:
So, I decided to add an out parameter to the I am certainly open to other options. |
Adds an optional
tested_by
documentation element to function documentation. This support is off by default and can be enabled with a command line argument or in the config file, as either an optional or required element. The element value is required to be an array of strings, or one of the supported tags (__OPTIONAL__
,__MISSING__
), depending on enablement category.Also adds support for outputting the emitted/reconciled documentation as JSON so it can be consumed by other tools.