docs: updated toHaveBeenCalled #14853
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for jestjs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
…/update-tohavebeencalled
…ul-turing/jest into docs/update-tohavebeencalled
|
Thanks for sending a PR! I thought this was resolved in #14847 - did we miss anything? |
|
This PR is stale because it has been open 90 days with no activity. Remove stale label or comment or this will be closed in 30 days. |
|
Oh, could you sign the CLA? |
|
@SimenB i have signed the CLA. Do let me know if anything else is required. |
|
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. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This modification addresses the concern raised in issue #14842. The issue highlights a redundancy in the descriptions of .toHaveBeenCalled() and .toHaveBeenCalledWith(), despite these two functions serving distinct purposes. The rationale for this change is rooted in the fact that .toHaveBeenCalled() pertains to scenarios where no function parameters are involved. Consequently, the description has been refined to accurately convey the functionality of
.toHaveBeenCalled, eliminating the redundant details about arguments and aligning it more precisely with its intended purpose.Furthermore, I have revised the descriptions in all versioned documents associated with this documentation issue.
Test plan
After revising the documentation, I executed it on the documentation website's node server to ensure that the changes were accurately reflected. The modifications were applied to Jest documentation versions Next, 29.7, 29.6, 29.5, and 29.4. The server's documentation now displays the corrected values.