docs: clarify invalid usage of done() #4101
Merged
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
When I first read "anything else will cause a failed test" I considered that this might be a typo, and that this should say "a passed test" instead, because after all setting "no error" could mean "no error", right? I then understood that this sentence could also mean that "anything else is a programmer error", i.e. a bug and I was hoping that in _that_ case a clear error would be thrown. I tried things out and indeed found that the latter is the case > Error: done() invoked with non-Error: true This patch attempts to clarify that this is indeed all about a programmer error.
|
|
|
@juergba would you mind having a quick look? Is hopefully a no-brainer. Thanks. |
|
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.
Please see commit message. Thanks!