Skip to content

Commit

Permalink
Minor formatting improvements to legacy sandbox documenation
Browse files Browse the repository at this point in the history
* Add code formatting to 2.3.0, 2.2.0
* Add missing closing </dl> to 2.1.0
  • Loading branch information
craig-davis authored and mantoni committed Oct 1, 2020
1 parent 0eed0af commit e27727a
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 9 deletions.
4 changes: 3 additions & 1 deletion docs/_releases/v2.1.0/sandbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,9 @@ sinon.defaultConfig = {
<dd>If <code>true</code>, the sandbox will have a <code>clock</code> property. Can also be an <code>Array</code> of timer properties to fake.</dd>

<dt><code>useFakeServer</code></dt>
<dd>If <code>true</code>, <code>server</code> and <code>requests</code> properties are added to the sandbox. Can also be an object to use for fake server. The default one is <code>sinon.fakeServer</code>, but if you're using jQuery 1.3.x or some other library that does not set the XHR's <code>onreadystatechange</code> handler, you might want to do:</dd>
<dd>If <code>true</code>, <code>server</code> and <code>requests</code> properties are added to the sandbox. Can also be an object to use for fake server. The default one is <code>sinon.fakeServer</code>, but if you're using jQuery 1.3.x or some other library that does not set the XHR's <code>onreadystatechange</code> handler, you might want to do:
</dd>
</dl>

```javascript
sinon.config = {
Expand Down
8 changes: 4 additions & 4 deletions docs/_releases/v2.2.0/sandbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,23 +62,23 @@ sinon.defaultConfig = {
}
```

##### injectInto
##### `injectInto`

The sandbox's methods can be injected into another object for convenience. The
`injectInto` configuration option can name an object to add properties to.

##### properties
##### `properties`

What properties to inject. Note that simply naming "server" here is not
sufficient to have a `server` property show up in the target object, you also
have to set `useFakeServer` to `true`.

##### useFakeTimers
##### `useFakeTimers`

If `true`, the sandbox will have a `clock` property. Can also be an `Array` of
timer properties to fake.

##### useFakeServer
##### `useFakeServer`

If `true`, `server` and `requests` properties are added to the sandbox. Can
also be an object to use for fake server. The default one is `sinon.fakeServer`,
Expand Down
8 changes: 4 additions & 4 deletions docs/_releases/v2.3.0/sandbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,23 +62,23 @@ sinon.defaultConfig = {
}
```

##### injectInto
##### `injectInto`

The sandbox's methods can be injected into another object for convenience. The
`injectInto` configuration option can name an object to add properties to.

##### properties
##### `properties`

What properties to inject. Note that simply naming "server" here is not
sufficient to have a `server` property show up in the target object, you also
have to set `useFakeServer` to `true`.

##### useFakeTimers
##### `useFakeTimers`

If `true`, the sandbox will have a `clock` property. Can also be an `Array` of
timer properties to fake.

##### useFakeServer
##### `useFakeServer`

If `true`, `server` and `requests` properties are added to the sandbox. Can
also be an object to use for fake server. The default one is `sinon.fakeServer`,
Expand Down

0 comments on commit e27727a

Please sign in to comment.