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: Update .toHaveBeenCalled() documentation #14847

Merged
merged 9 commits into from
Jan 17, 2024

Conversation

arescrimson
Copy link
Contributor

@arescrimson arescrimson commented Jan 12, 2024

Summary

This change concerns issue #14842, where .toHaveBeenCalled() and .toHaveBeenCalledWith() have duplicate descriptions despite serving two different functionalities. I made this change because .toHaveBeenCalled() refers to an example where there are no function parameters, and therefore should be updated accordingly because it was not called with specific arguments. Therefore, I took out the argument explanations and simply revised the description to correctly reflect .toHaveBeenCalled's functionality.

I additionally updated the descriptions for all versioned docs which concern this documentation issue.

Fixes #14842

Test plan

By updating the documentation, I then ran it on the documentation website node server to make sure changes were updated accordingly. Jest documentation versions 29.7, 29.6, 29.5, and 29.4 were changed.

Documentation on the server now showing corrected values.

image
image
image
image

Updated .toHaveBeenCalled name and description. Its description now correctly reflects that it is not called with any arguments.
Updated .toHaveBeenCalled name and description. Its description now correctly reflects that it is not called with any arguments.
Updated .toHaveBeenCalled name and description. Its description now correctly reflects that it is not called with any arguments.
Updated .toHaveBeenCalled name and description. Its description now correctly reflects that it is not called with any arguments.
Copy link

netlify bot commented Jan 12, 2024

Deploy Preview for jestjs ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 18895d8
🔍 Latest deploy log https://app.netlify.com/sites/jestjs/deploys/65a7867d99a2d70008cadd2d
😎 Deploy Preview https://deploy-preview-14847--jestjs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

arescrimson and others added 4 commits January 11, 2024 19:04
Updated changelog entry to be more reflective of change.
Updated with more specific documentation change descriptions in changelog.
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!

@SimenB SimenB merged commit 8c78a08 into jestjs:main Jan 17, 2024
8 of 9 checks passed
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 Feb 17, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs]: duplicate explanation
2 participants