New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add example usage to istanbul-lib-report #425
Conversation
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.
Thanks for starting this! Documentation in the monorepo is very much lacking, most documentation work has been on nyc itself for end-users. I have a couple comments and have requested a review by @JaKXz.
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.
At first glance my major request is to have more descriptive variable names and even inline comments to explain the context and intent of the code and what it's doing.
Maybe another source for good examples would be jest's codebase, for inspiration :)
jest is currently not a good place to look. jest is using the current version of istanbul modules. index.js on istanbuljs/nyc#1134 is probably the only code that is using the |
Fixed comments. I'm not saying this is perfect - its just I tried the alpha and updated my codebase and I ended up using the example on the refactor pr description, so I did this as I went along and made a PR so that something exists ;) |
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.
Thanks @lukeapage - I have some minor things that I think would make things clearer - writing this review as a quick set of TODOs
@lukeapage thanks for contributing! |
Doesn't seem to work with
|
@Hypnosphi that is true, these docs are for the 3.x versions (currently pre-release). |
No description provided.