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: adds details to test results processor config option #12206

Merged
merged 5 commits into from Feb 7, 2022

Conversation

zoltan-boros
Copy link
Contributor

@zoltan-boros zoltan-boros commented Jan 1, 2022

Summary

Based on the documentation (https://jestjs.io/docs/configuration) it was unclear to me what a test result processor (config option: testResultsProcessor), respectively a reporter (config option: reporters) does. Documentation makes the impression that they have the same purpose.
After searching on the internet I found some clue: jest-community/jest-junit#158
I would like to add this little piece of information to Jest docs.

Test plan

None. Only documentatin changed.

@codecov-commenter
Copy link

codecov-commenter commented Jan 1, 2022

Codecov Report

Merging #12206 (873dfd4) into main (12a983b) will decrease coverage by 0.00%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #12206      +/-   ##
==========================================
- Coverage   67.53%   67.52%   -0.01%     
==========================================
  Files         328      328              
  Lines       17244    17244              
  Branches     5069     5069              
==========================================
- Hits        11645    11644       -1     
- Misses       5566     5567       +1     
  Partials       33       33              
Impacted Files Coverage Δ
packages/expect/src/utils.ts 96.03% <0.00%> (-0.50%) ⬇️

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 12a983b...873dfd4. Read the comment docs.

Copy link
Contributor

@Biki-das Biki-das left a comment

looks good , could you make the changes in the other versions of doc too, and add it to the main doc folder too

@zoltan-boros
Copy link
Contributor Author

zoltan-boros commented Jan 9, 2022

looks good , could you make the changes in the other versions of doc too, and add it to the main doc folder too

Sorry for the delayed reply.
I added the change to /docs too.
Regarding older versions: I would prefer not to alter the past.
Would you mind if I keep older versions as they are?

@SimenB
Copy link
Collaborator

SimenB commented Feb 5, 2022

Please update all versions of the docs, people still use older versions, so the docs should reflect the latest information relevant for that version of Jest 🙂

@zoltan-boros
Copy link
Contributor Author

zoltan-boros commented Feb 6, 2022

@SimenB, Thank you for taking care of this PR.
I added the doc change to every version of the docs.

SimenB
SimenB approved these changes Feb 7, 2022
Copy link
Collaborator

@SimenB SimenB left a comment

thanks!

@github-actions
Copy link

github-actions bot commented Mar 11, 2022

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 Mar 11, 2022
@zoltan-boros zoltan-boros deleted the docs/test-results-processor branch Mar 15, 2022
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.

None yet

5 participants