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

Update spyOn docs #13000

Merged
merged 7 commits into from Jul 13, 2022
Merged

Update spyOn docs #13000

merged 7 commits into from Jul 13, 2022

Conversation

MiguelYax
Copy link
Contributor

@MiguelYax MiguelYax commented Jul 8, 2022

Resolve #4828

Update jest.spyOn documentation.

Lemme know if this should be mirrored to the versioned doc as well.
Summary

This will help folks to understand how to restore the initial status of spies.

Test plan

Just doc, so probably preview pane in Github UI for now.

@facebook-github-bot
Copy link
Contributor

Hi @MiguelYax!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, 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.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

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

@MiguelYax MiguelYax closed this Jul 8, 2022
@MiguelYax MiguelYax reopened this Jul 8, 2022
@MiguelYax MiguelYax closed this Jul 8, 2022
@MiguelYax MiguelYax reopened this Jul 8, 2022
@MiguelYax MiguelYax changed the title Update spyOn docs #4828 Update spyOn docs #4828 Jul 8, 2022
@facebook-github-bot
Copy link
Contributor

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

CHANGELOG.md Outdated Show resolved Hide resolved
@@ -500,14 +506,16 @@ Example test:
```js
const video = require('./video');

afterEach(() => {
jest.restoreAllMocks();
Copy link
Contributor

Choose a reason for hiding this comment

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

Perhaps instead of a tip, short comment could be added here explaining that this will restore state of the spy?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi @mrazauskas, I added a comment on afterEach hook on this commit 6fa35fe

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!

@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 Aug 13, 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.

spyOn docs misleading?
4 participants