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

docs: mention about optional done argument in test fn #4556

Merged
merged 2 commits into from
Sep 28, 2017
Merged

docs: mention about optional done argument in test fn #4556

merged 2 commits into from
Sep 28, 2017

Conversation

jukben
Copy link
Contributor

@jukben jukben commented Sep 28, 2017

Summary

Updated general API docs. I've missed mention about an optional parameter of the test function.

I've run into an issue that my test hangs because I've defined the parameter for the test callback. Could be handy to mention that.

I've run into an issue that my test hangs because I've defined the parameter for the test callback. Could be handy to mention that.
@facebook-github-bot
Copy link
Contributor

Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. In order for us to review and merge your code, please sign up at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need the corporate CLA signed.

If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks!

@codecov-io
Copy link

codecov-io commented Sep 28, 2017

Codecov Report

Merging #4556 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #4556   +/-   ##
=======================================
  Coverage   56.03%   56.03%           
=======================================
  Files         185      185           
  Lines        6267     6267           
  Branches        3        3           
=======================================
  Hits         3512     3512           
  Misses       2754     2754           
  Partials        1        1

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ff469e0...9439645. Read the comment docs.

@facebook-github-bot
Copy link
Contributor

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

Copy link
Collaborator

@thymikee thymikee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @jukben! I've updated the message a bit, so it stands out a bit more.

@thymikee thymikee changed the title Updated docs for Test. Added mention about optional done argument docs: mention about optional done argument in test fn Sep 28, 2017
@facebook-github-bot
Copy link
Contributor

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

@cpojer cpojer merged commit 1e3ee68 into jestjs:master Sep 28, 2017
@cpojer
Copy link
Member

cpojer commented Sep 28, 2017

Nice update! This is a good clarification.

tabrindle pushed a commit to tabrindle/jest that referenced this pull request Oct 2, 2017
* docs(testAPI): mention about optional `done` argument

I've run into an issue that my test hangs because I've defined the parameter for the test callback. Could be handy to mention that.

* Update GlobalAPI.md
@github-actions
Copy link

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 13, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants