Skip to content
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

JSDoc coverage for Should and Expect #354

Closed
Soviut opened this issue Jan 29, 2015 · 4 comments
Closed

JSDoc coverage for Should and Expect #354

Soviut opened this issue Jan 29, 2015 · 4 comments

Comments

@Soviut
Copy link

Soviut commented Jan 29, 2015

The Assert interface has JSDoc coverage but Should and Expect don't. In order to keep documentation in sync, this would be good to propagate.

@keithamus
Copy link
Member

@Soviut thanks for the issue - sorry I seemed to have missed this one before. Please feel free to make a PR, and we can merge it in and get the documentation in sync!

@reggi
Copy link

reggi commented Jul 30, 2015

@Soviut What do you mean Asset has JSDoc coverage? Where is this documented?

@Soviut
Copy link
Author

Soviut commented Jul 30, 2015

@reggi The Assert library has JSDoc comments, Should and Expect don't. Here's an example https://github.com/chaijs/chai/blob/master/lib/chai/assertion.js#L24

@reggi
Copy link

reggi commented Jul 30, 2015

Gotcha @Soviut thanks for the explication!

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

No branches or pull requests

3 participants