Wrong example in Sandbox documentation

[kibertoad]

• Sinon version : 5.0.7

Documentation seems to be wrong. Here is a code snippet from http://sinonjs.org/releases/v5.0.7/sandbox/:

var sandbox = require('sinon').sandbox;
var myAPI = { hello: function () {} };

describe('myAPI.hello method', function () {

    beforeEach(function () {
        // stub out the `hello` method
        sandbox.stub(myAPI, 'hello');
    });

    afterEach(function () {
        // completely restore all fakes created through the sandbox
        sandbox.restore();
    });

This fails with "sandbox.stub is not a function" error.
Probably ".sandbox" in the first line should be replaced with "createSandbox();"?

[pgoldrbx]

The sinon module exports a default sandbox instance.
https://github.com/sinonjs/sinon/blob/master/lib/sinon.js#L60

So really it would be var sandbox = require('sinon') or just var sinon = require('sinon') will the sandbox API methods available.

var foo = {
  bar: function () {}
};
sinon.stub(foo, 'bar');
sinon.restore();

So the docs will need a little reworking to explain this.

[fatso83]

@kibertoad You are correct. Would you mind try to update the doc sources with a PR?

@pgoldrbx It's correct that in recent Sinon versions it exports a default sandbox instance, but the Sandbox documentation should still explicitly mention how to create sandboxes and deal with them directly. The non-sandbox pieces can still refer to this section for details (once it is correct ...).

[kibertoad]

@fatso83 Sure, will create a PR in the evening.

[mroderick]

This was fixed with #1792