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) Add missing numTodoTests in Result Object. #7976

Merged
merged 3 commits into from
Feb 25, 2019

Conversation

dashmug
Copy link
Contributor

@dashmug dashmug commented Feb 25, 2019

Reference: https://github.com/facebook/jest/blob/master/types/TestResult.js#L128

Summary

This PR simply updates the documentation for testResultsProcessor. https://jestjs.io/docs/en/configuration#testresultsprocessor-string

Test plan

Run jest with --json. The JSON output will contain a numeric numTodoTests property.

@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!

@jeysal
Copy link
Contributor

jeysal commented Feb 25, 2019

Thanks for the contribution!
Could you also update the versioned_docs for 24.x? (The test.todo feature has existed since Jest 24)
Also, maybe we should move numTodoTests below numTotalTests like the other num*Tests, otherwise people might think they're not included in the total number? Dunno if it gives that impression

@dashmug
Copy link
Contributor Author

dashmug commented Feb 25, 2019

@jeysal I've updated this PR.

@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
Member

@SimenB SimenB left a comment

Choose a reason for hiding this comment

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

Thank you!

@SimenB SimenB merged commit 51817fd into jestjs:master Feb 25, 2019
@dashmug dashmug deleted the update-doc-with-numTodoTests branch March 30, 2019 13:24
@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 11, 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.

4 participants