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

Jump to bottom

docs: correct confusing filename in enableAutomock example #10055

Merged
merged 2 commits into from May 18, 2020
Merged

docs: correct confusing filename in enableAutomock example #10055

merged 2 commits into from May 18, 2020

Conversation

duxtinto
Copy link
Contributor

@duxtinto duxtinto commented May 17, 2020 •
edited

Summary

Current example for jest.enableAutomock() functionality uses disableAutomocking.js as the filename for the example test file:

image

it results confusing for the reader.

Test plan

Here you can see a screenshot of the built website after the changes:
image

@facebook-github-bot
Copy link
Contributor

Hi @duxtinto!

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 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 to sign the corporate CLA.

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

@duxtinto duxtinto force-pushed the chore/docs/fix-confusing-example-for-jest-object branch from a0cc8dd to 8533528 Compare May 17, 2020 08:32
@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!

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

@duxtinto duxtinto force-pushed the chore/docs/fix-confusing-example-for-jest-object branch from 8533528 to 1fd8816 Compare May 17, 2020 08:55
@duxtinto duxtinto marked this pull request as ready for review May 17, 2020 08:55
kenrick95
kenrick95 reviewed May 17, 2020
View reviewed changes
CHANGELOG.md Outdated Show resolved Hide resolved
SimenB
SimenB approved these changes May 17, 2020
View reviewed changes
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.

Thanks! Quick cleanup in the changelog as pointed out and I think this is ready to go 👍

@duxtinto duxtinto force-pushed the chore/docs/fix-confusing-example-for-jest-object branch from 1fd8816 to e0385d3 Compare May 18, 2020 07:32
@duxtinto duxtinto requested a review from SimenB May 18, 2020 07:33
@duxtinto
Copy link
Contributor Author

Hi @kenrick95 & @SimenB !

After implementing the requested change, the PR is ready for review now.

Thanks

@SimenB SimenB changed the title docs: Fix confuse filename on enableAutomock example docs: correct confusing filename in enableAutomock example May 18, 2020
@SimenB SimenB merged commit 6cef23b into jestjs:master May 18, 2020
@SimenB
Copy link
Member

SimenB commented May 18, 2020

Thanks @duxtinto!

@duxtinto duxtinto deleted the chore/docs/fix-confusing-example-for-jest-object branch May 18, 2020 09:28
jeysal added a commit to jeysal/jest that referenced this pull request May 25, 2020
@jeysal
Merge remote-tracking branch 'upstream/master' into runtime-require-r…
0b3e556 
…esolve-outside

* upstream/master: (106 commits)
  docs: fix jest-diff example (jestjs#10067)
  Cleanup `displayName` type (jestjs#10049)
  docs: correct confusing filename in `enableAutomock` example (jestjs#10055)
  chore: minor optimize getTransformer (jestjs#10050)
  chore: fix TestUtils.ts to match the types (jestjs#10034)
  Minor test name typo fix (jestjs#10033)
  chore: upgrade to typescript 3.9 (jestjs#10031)
  feat: CLI argument to filter tests by projects (jestjs#8612)
  chore: bump `istanbul-lib-instrument` (jestjs#10009)
  feat: support config files exporting (`async`) `function`s (jestjs#10001)
  fix: add missing haste-map dep to jest-snapshot (jestjs#10008)
  🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉🎉 (jestjs#10000)
  Fix typo in dependency warning (jestjs#10006)
  chore: add missing comma (jestjs#9999)
  fix: Control no diff message color with diff options (jestjs#9997)
  fix(jest-jasmine2): fix Error message (jestjs#9990)
  docs: fix jest-object ids for docusaurs (jestjs#9994)
  docs: fix Configuration, JestPlatform and JestObjectAPI docs for 26 (jestjs#9985)
  Add migration notes for breaking changes (jestjs#9978)
  chore: fix date and heading in blog post (jestjs#9977)
  ...
@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.
Reviewers

@kenrick95 kenrick95 kenrick95 left review comments

@SimenB SimenB Awaiting requested review from SimenB

Assignees
No one assigned
Labels
cla signed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@duxtinto @facebook-github-bot @SimenB @kenrick95