Added docs code snippet for createStubInstance #1423
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
I couldn't think of a third sentence that added to the docs :) but am open to proposals.
fatso83
reviewed
May 25, 2017
docs/release-source/release/utils.md
Outdated
| @@ -30,7 +30,17 @@ Restores supplied method | |||
|
|
|||
| #### `sinon.createStubInstance(constructor);` | |||
|
|
|||
| Creates a new object with the given function as the protoype and stubs all implemented functions. | |||
There was a problem hiding this comment.
Not sure if this is an improvement. A class IS A function along with its prototype. It's not either/or. Might help the ones that don't know the basics, but still...
There was a problem hiding this comment.
Agreed. Having an explanation that says function and a code snippet with a class should be fine.
| contains(item) { /* ... */ } | ||
| } | ||
|
|
||
| var stubContainer = sinon.createStubInstance(Container); |
|
Thank you @JoshuaKGoldberg! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I couldn't think of a third sentence that added to the docs :) but am open to proposals.
Fixes #1421.