fix: align restoreObject docs test with idempotent behavior#2745
Merged
Conversation
restoreObject was made idempotent in #2737 — it no longer throws for objects with no restorable methods. Updates the docs page and its corresponding test to reflect this.
mroderick
approved these changes
Jul 20, 2026
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2745 +/- ##
=======================================
Coverage 97.44% 97.44%
=======================================
Files 39 39
Lines 1838 1838
=======================================
Hits 1791 1791
Misses 47 47
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
PR #2737 intentionally made
sinon.restoreObjectidempotent — calling it on an object with no restorable methods now silently returns the object instead of throwing. The docs page and its corresponding test still documented the old throwing behavior, causing the Docs CI workflow to fail.Changes
docs/tests/docs/utils-3.test.js: Changed fromt.throwstot.doesNotThrowwith updated test descriptiondocs/concepts/utils.md: Updated description from "Throws an error" to "Does nothing" if the object contains no restorable methodsRelated