[Document]: Error/undefined params to the 'done' callback #3192
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
boneskull
suggested changes
Jan 3, 2018
docs/index.md
Outdated
| @@ -155,7 +155,7 @@ Mocha allows you to use any assertion library you wish. In the above example, w | |||
|
|
|||
| ## Asynchronous Code | |||
|
|
|||
| Testing asynchronous code with Mocha could not be simpler! Simply invoke the callback when your test is complete. By adding a callback (usually named `done`) to `it()`, Mocha will know that it should wait for this function to be called to complete the test. | |||
| Testing asynchronous code with Mocha could not be simpler! Simply invoke the callback when your test is complete. By adding a callback (usually named `done`) to `it()`, Mocha will know that it should wait for this function to be called to complete the test. This callback accepts both an `Error` instance, or `undefined`. | |||
There was a problem hiding this comment.
#3134 isn't quite accurate about what needs to be documented.
We need to document that any non-falsy, non-Error instance passed into done() will cause Mocha to fail.
Subclasses of Error are allowed.
There was a problem hiding this comment.
Can you check if that is accurate?
docs/index.md
Outdated
| @@ -184,6 +184,7 @@ describe('User', function() { | |||
| }); | |||
| ``` | |||
|
|
|||
|
|
|||
boneskull
added
area: documentation
|
@boneskull do you think we can get this merged? Kinda excited to have committed something that was merged into Mocha. |
boneskull
suggested changes
Jan 4, 2018
docs/index.md
Outdated
| @@ -171,7 +171,7 @@ describe('User', function() { | |||
| }); | |||
| ``` | |||
|
|
|||
| To make things even easier, the `done()` callback accepts an error, so we may use this directly: | |||
| To make things even easier, the `done()` callback also accepts an `Error` instance (ie, `new Error()`), so we may use this directly: | |||
docs/index.md
Outdated
| @@ -155,7 +155,7 @@ Mocha allows you to use any assertion library you wish. In the above example, w | |||
|
|
|||
| ## Asynchronous Code | |||
|
|
|||
| Testing asynchronous code with Mocha could not be simpler! Simply invoke the callback when your test is complete. By adding a callback (usually named `done`) to `it()`, Mocha will know that it should wait for this function to be called to complete the test. | |||
| Testing asynchronous code with Mocha could not be simpler! Simply invoke the callback when your test is complete. By adding a callback (usually named `done`) to `it()`, Mocha will know that it should wait for this function to be called to complete the test. This callback accepts both an `Error` (or subclassed) instance, or `undefined`, any non-falsy will cause a failed test. | |||
There was a problem hiding this comment.
Sorry, let's just eliminate undefined altogether here. it's also a bit of a run-on sentence. how about:
This callback accepts both an `Error` instance (or subclass thereof) *or* a falsy value; anything else will cause a failed test.
boneskull
approved these changes
Jan 9, 2018
|
thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves: #3134