Merge pull request #1973 from mgred/default-sandbox-example

docs(sandbox): add example for default sandbox

docs/_releases/latest/sandbox.md

@@ -41,6 +41,21 @@ describe('myAPI.hello method', function () {
 
 Since `sinon@5.0.0`, the `sinon` object is a default sandbox. Unless you have a very advanced setup or need a special configuration, you probably want to just use that one.
 
+```javascript
+const myObject = {
+    'hello': 'world'
+};
+
+sinon.stub(myObject, 'hello').value('Sinon');
+
+console.log(myObject.hello);
+// Sinon
+
+sinon.restore();
+console.log(myObject.hello);
+// world
+```
+
 #### `var sandbox = sinon.createSandbox();`
 
 Creates a new sandbox object with spies, stubs, and mocks.

docs/_releases/v5.0.1/sandbox.md

@@ -41,6 +41,21 @@ describe('myAPI.hello method', function () {
 
 Since `sinon@5.0.0`, the `sinon` object is a default sandbox. Unless you have a very advanced setup or need a special configuration, you probably want to just use that one.
 
+```javascript
+const myObject = {
+    'hello': 'world'
+};
+
+sinon.stub(myObject, 'hello').value('Sinon');
+
+console.log(myObject.hello);
+// Sinon
+
+sinon.restore();
+console.log(myObject.hello);
+// world
+```
+
 #### `var sandbox = sinon.createSandbox();`
 
 Creates a new sandbox object with spies, stubs, and mocks.

docs/_releases/v5.0.10/sandbox.md

@@ -41,6 +41,21 @@ describe('myAPI.hello method', function () {
 
 Since `sinon@5.0.0`, the `sinon` object is a default sandbox. Unless you have a very advanced setup or need a special configuration, you probably want to just use that one.
 
+```javascript
+const myObject = {
+    'hello': 'world'
+};
+
+sinon.stub(myObject, 'hello').value('Sinon');
+
+console.log(myObject.hello);
+// Sinon
+
+sinon.restore();
+console.log(myObject.hello);
+// world
+```
+
 #### `var sandbox = sinon.createSandbox();`
 
 Creates a new sandbox object with spies, stubs, and mocks.

docs/_releases/v5.0.2/sandbox.md

@@ -41,6 +41,21 @@ describe('myAPI.hello method', function () {
 
 Since `sinon@5.0.0`, the `sinon` object is a default sandbox. Unless you have a very advanced setup or need a special configuration, you probably want to just use that one.
 
+```javascript
+const myObject = {
+    'hello': 'world'
+};
+
+sinon.stub(myObject, 'hello').value('Sinon');
+
+console.log(myObject.hello);
+// Sinon
+
+sinon.restore();
+console.log(myObject.hello);
+// world
+```
+
 #### `var sandbox = sinon.createSandbox();`
 
 Creates a new sandbox object with spies, stubs, and mocks.

docs/_releases/v5.0.3/sandbox.md

@@ -41,6 +41,21 @@ describe('myAPI.hello method', function () {
 
 Since `sinon@5.0.0`, the `sinon` object is a default sandbox. Unless you have a very advanced setup or need a special configuration, you probably want to just use that one.
 
+```javascript
+const myObject = {
+    'hello': 'world'
+};
+
+sinon.stub(myObject, 'hello').value('Sinon');
+
+console.log(myObject.hello);
+// Sinon
+
+sinon.restore();
+console.log(myObject.hello);
+// world
+```
+
 #### `var sandbox = sinon.createSandbox();`
 
 Creates a new sandbox object with spies, stubs, and mocks.

docs/_releases/v5.0.4/sandbox.md

@@ -41,6 +41,21 @@ describe('myAPI.hello method', function () {
 
 Since `sinon@5.0.0`, the `sinon` object is a default sandbox. Unless you have a very advanced setup or need a special configuration, you probably want to just use that one.
 
+```javascript
+const myObject = {
+    'hello': 'world'
+};
+
+sinon.stub(myObject, 'hello').value('Sinon');
+
+console.log(myObject.hello);
+// Sinon
+
+sinon.restore();
+console.log(myObject.hello);
+// world
+```
+
 #### `var sandbox = sinon.createSandbox();`
 
 Creates a new sandbox object with spies, stubs, and mocks.

docs/_releases/v5.0.5/sandbox.md

@@ -41,6 +41,21 @@ describe('myAPI.hello method', function () {
 
 Since `sinon@5.0.0`, the `sinon` object is a default sandbox. Unless you have a very advanced setup or need a special configuration, you probably want to just use that one.
 
+```javascript
+const myObject = {
+    'hello': 'world'
+};
+
+sinon.stub(myObject, 'hello').value('Sinon');
+
+console.log(myObject.hello);
+// Sinon
+
+sinon.restore();
+console.log(myObject.hello);
+// world
+```
+
 #### `var sandbox = sinon.createSandbox();`
 
 Creates a new sandbox object with spies, stubs, and mocks.

docs/_releases/v5.0.6/sandbox.md

@@ -41,6 +41,21 @@ describe('myAPI.hello method', function () {
 
 Since `sinon@5.0.0`, the `sinon` object is a default sandbox. Unless you have a very advanced setup or need a special configuration, you probably want to just use that one.
 
+```javascript
+const myObject = {
+    'hello': 'world'
+};
+
+sinon.stub(myObject, 'hello').value('Sinon');
+
+console.log(myObject.hello);
+// Sinon
+
+sinon.restore();
+console.log(myObject.hello);
+// world
+```
+
 #### `var sandbox = sinon.createSandbox();`
 
 Creates a new sandbox object with spies, stubs, and mocks.

docs/_releases/v5.0.7/sandbox.md

@@ -41,6 +41,21 @@ describe('myAPI.hello method', function () {
 
 Since `sinon@5.0.0`, the `sinon` object is a default sandbox. Unless you have a very advanced setup or need a special configuration, you probably want to just use that one.
 
+```javascript
+const myObject = {
+    'hello': 'world'
+};
+
+sinon.stub(myObject, 'hello').value('Sinon');
+
+console.log(myObject.hello);
+// Sinon
+
+sinon.restore();
+console.log(myObject.hello);
+// world
+```
+
 #### `var sandbox = sinon.createSandbox();`
 
 Creates a new sandbox object with spies, stubs, and mocks.

docs/_releases/v5.0.8/sandbox.md

@@ -41,6 +41,21 @@ describe('myAPI.hello method', function () {
 
 Since `sinon@5.0.0`, the `sinon` object is a default sandbox. Unless you have a very advanced setup or need a special configuration, you probably want to just use that one.
 
+```javascript
+const myObject = {
+    'hello': 'world'
+};
+
+sinon.stub(myObject, 'hello').value('Sinon');
+
+console.log(myObject.hello);
+// Sinon
+
+sinon.restore();
+console.log(myObject.hello);
+// world
+```
+
 #### `var sandbox = sinon.createSandbox();`
 
 Creates a new sandbox object with spies, stubs, and mocks.

docs/_releases/v5.0.9/sandbox.md

@@ -41,6 +41,21 @@ describe('myAPI.hello method', function () {
 
 Since `sinon@5.0.0`, the `sinon` object is a default sandbox. Unless you have a very advanced setup or need a special configuration, you probably want to just use that one.
 
+```javascript
+const myObject = {
+    'hello': 'world'
+};
+
+sinon.stub(myObject, 'hello').value('Sinon');
+
+console.log(myObject.hello);
+// Sinon
+
+sinon.restore();
+console.log(myObject.hello);
+// world
+```
+
 #### `var sandbox = sinon.createSandbox();`
 
 Creates a new sandbox object with spies, stubs, and mocks.

docs/_releases/v5.1.0/sandbox.md

@@ -41,6 +41,21 @@ describe('myAPI.hello method', function () {
 
 Since `sinon@5.0.0`, the `sinon` object is a default sandbox. Unless you have a very advanced setup or need a special configuration, you probably want to just use that one.
 
+```javascript
+const myObject = {
+    'hello': 'world'
+};
+
+sinon.stub(myObject, 'hello').value('Sinon');
+
+console.log(myObject.hello);
+// Sinon
+
+sinon.restore();
+console.log(myObject.hello);
+// world
+```
+
 #### `var sandbox = sinon.createSandbox();`
 
 Creates a new sandbox object with spies, stubs, and mocks.

docs/_releases/v6.0.0/sandbox.md

@@ -41,6 +41,21 @@ describe('myAPI.hello method', function () {
 
 Since `sinon@5.0.0`, the `sinon` object is a default sandbox. Unless you have a very advanced setup or need a special configuration, you probably want to just use that one.
 
+```javascript
+const myObject = {
+    'hello': 'world'
+};
+
+sinon.stub(myObject, 'hello').value('Sinon');
+
+console.log(myObject.hello);
+// Sinon
+
+sinon.restore();
+console.log(myObject.hello);
+// world
+```
+
 #### `var sandbox = sinon.createSandbox();`
 
 Creates a new sandbox object with spies, stubs, and mocks.

docs/_releases/v6.0.1/sandbox.md

@@ -41,6 +41,21 @@ describe('myAPI.hello method', function () {
 
 Since `sinon@5.0.0`, the `sinon` object is a default sandbox. Unless you have a very advanced setup or need a special configuration, you probably want to just use that one.
 
+```javascript
+const myObject = {
+    'hello': 'world'
+};
+
+sinon.stub(myObject, 'hello').value('Sinon');
+
+console.log(myObject.hello);
+// Sinon
+
+sinon.restore();
+console.log(myObject.hello);
+// world
+```
+
 #### `var sandbox = sinon.createSandbox();`
 
 Creates a new sandbox object with spies, stubs, and mocks.

docs/_releases/v6.1.0/sandbox.md

@@ -41,6 +41,21 @@ describe('myAPI.hello method', function () {
 
 Since `sinon@5.0.0`, the `sinon` object is a default sandbox. Unless you have a very advanced setup or need a special configuration, you probably want to just use that one.
 
+```javascript
+const myObject = {
+    'hello': 'world'
+};
+
+sinon.stub(myObject, 'hello').value('Sinon');
+
+console.log(myObject.hello);
+// Sinon
+
+sinon.restore();
+console.log(myObject.hello);
+// world
+```
+
 #### `var sandbox = sinon.createSandbox();`
 
 Creates a new sandbox object with spies, stubs, and mocks.

docs/_releases/v6.1.1/sandbox.md

@@ -41,6 +41,21 @@ describe('myAPI.hello method', function () {
 
 Since `sinon@5.0.0`, the `sinon` object is a default sandbox. Unless you have a very advanced setup or need a special configuration, you probably want to just use that one.
 
+```javascript
+const myObject = {
+    'hello': 'world'
+};
+
+sinon.stub(myObject, 'hello').value('Sinon');
+
+console.log(myObject.hello);
+// Sinon
+
+sinon.restore();
+console.log(myObject.hello);
+// world
+```
+
 #### `var sandbox = sinon.createSandbox();`
 
 Creates a new sandbox object with spies, stubs, and mocks.

docs/_releases/v6.1.2/sandbox.md

@@ -41,6 +41,21 @@ describe('myAPI.hello method', function () {
 
 Since `sinon@5.0.0`, the `sinon` object is a default sandbox. Unless you have a very advanced setup or need a special configuration, you probably want to just use that one.
 
+```javascript
+const myObject = {
+    'hello': 'world'
+};
+
+sinon.stub(myObject, 'hello').value('Sinon');
+
+console.log(myObject.hello);
+// Sinon
+
+sinon.restore();
+console.log(myObject.hello);
+// world
+```
+
 #### `var sandbox = sinon.createSandbox();`
 
 Creates a new sandbox object with spies, stubs, and mocks.

docs/_releases/v6.1.3/sandbox.md

@@ -41,6 +41,21 @@ describe('myAPI.hello method', function () {
 
 Since `sinon@5.0.0`, the `sinon` object is a default sandbox. Unless you have a very advanced setup or need a special configuration, you probably want to just use that one.
 
+```javascript
+const myObject = {
+    'hello': 'world'
+};
+
+sinon.stub(myObject, 'hello').value('Sinon');
+
+console.log(myObject.hello);
+// Sinon
+
+sinon.restore();
+console.log(myObject.hello);
+// world
+```
+
 #### `var sandbox = sinon.createSandbox();`
 
 Creates a new sandbox object with spies, stubs, and mocks.