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.

Sign up for GitHub

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

Jump to bottom

docs: clarify invalid usage of done() #4101

Merged
merged 1 commit into from
Nov 23, 2019
Merged

docs: clarify invalid usage of done() #4101

merged 1 commit into from
Nov 23, 2019

Conversation

jgehrcke
Copy link
Contributor

Please see commit message. Thanks!

@jgehrcke
docs: clarify invalid usage of done()
a3c24ca 
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.
@jsf-clabot
Copy link

jsf-clabot commented Nov 21, 2019 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@coveralls
Copy link

Coverage Status

Coverage increased (+0.07%) to 92.808% when pulling a3c24ca on jgehrcke:patch-1 into b9fbd69 on mochajs:master.

@jgehrcke
Copy link
Contributor Author

@juergba would you mind having a quick look? Is hopefully a no-brainer. Thanks.

@craigtaub craigtaub added the area: documentation anything involving docs or mochajs.org label Nov 23, 2019
@craigtaub craigtaub merged commit ebdee97 into mochajs:master Nov 23, 2019
@craigtaub craigtaub added this to the next milestone Nov 23, 2019
@juergba juergba modified the milestones: next, v7.0.0 Jan 4, 2020
@jgehrcke
Copy link
Contributor Author

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
area: documentation anything involving docs or mochajs.org
Projects
None yet
Milestone
v7.0.0
Development

Successfully merging this pull request may close these issues.
5 participants
@jgehrcke @jsf-clabot @coveralls @craigtaub @juergba