Closed DanKaplanSES closed 10 months ago
All modified and coverable lines are covered by tests :white_check_mark:
Comparison is base (
adcf936
) 96.02% compared to head (15b2b33
) 96.02%.
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
Alternatively, could it make sense to move all of the createStubInstance docs into stubs.md
I get it from the name, but it's not a method on the stubs object, and it's mostly similar by name only. If it should be moved somewhere, I guess it would be on the sandbox, if anything. But linking from different docs is highly effective and we should only do it more than we do.
I know the docs are far from perfect, but it's what we have now. I know @mroderick is cooking on something, but I don't know the state of it, just that it probably will be different in some way (not sure of the goals ATM, just that it should be better :) ).
@fatso83
I guess it would be on the sandbox, if anything. But linking from different docs is highly effective and we should only do it more than we do.
Hm, that's interesting. Until your comment on this issue, I didn't realize this was documented in three places. Should I submit a PR to add links to the other docs in these places?
It doesn't mean that the docs are correct, though ... I see that the docs say that there is a difference between the sinon. createStubInstance
and sandbox.createStubInstance
, but that might be leftovers from the Sinon 1.x days. As of Sinon 2.0, the default sinon
instance is a sandbox. Cannot see how they are different (please test if you think otherwise)? So I'd rather just have the docs in one place and just link to that.
So I'd rather just have the docs in one place and just link to that.
I think I understand but I'm not 100% sure. In other words, the sandbox documentation should be the one and only place to document createStubInstance
and the stub/util documents should mostly link to it.
Purpose (TL;DR) - mandatory
The Utilities documentation contains valuable information about
createStubInstance
, but I didn't see any way to know that unless you happen to have already viewed the Utilities page.Alternatively, could it make sense to move all of the
createStubInstance
docs into stubs.md? For me, that's where I would expect to find everything there is to know aboutcreateStubInstance
, or at least the behavior it provides.How to verify - mandatory
npm install
Checklist for author
npm run lint
passes