Skip to content

Commit

Permalink
Resolve #2305 by fixing broken 'matchers' link (#2308)
Browse files Browse the repository at this point in the history
* Resolve #2305 and fix broken 'matchers' link

* fix broken 'matchers' links in all _releases
  • Loading branch information
sjoseph7 committed Oct 29, 2020
1 parent f981192 commit 28e64b1
Show file tree
Hide file tree
Showing 40 changed files with 142 additions and 80 deletions.
7 changes: 4 additions & 3 deletions docs/_releases/latest/spies.md
Expand Up @@ -156,7 +156,7 @@ are also available on `object.method`.

Creates a spy that only records [calls][call] when the received arguments match those passed to `withArgs`. This is useful to be more expressive in your assertions, where you can access the spy with the same [call][call].

Uses deep comparison for objects and arrays. Use `spy.withArgs(sinon.match.same(obj))` for strict comparison (see [matchers](matchers)).
Uses deep comparison for objects and arrays. Use `spy.withArgs(sinon.match.same(obj))` for strict comparison (see [matchers][matchers]).

<div data-example-id="spies-7-with-args"></div>

Expand Down Expand Up @@ -235,7 +235,7 @@ occurred between `anotherSpy` and `spy`.

#### `spy.calledOn(obj);`

Returns `true` if the spy was called at least once with `obj` as `this`. `calledOn` also accepts a matcher `spyCall.calledOn(sinon.match(fn))` (see [matchers](matchers)).
Returns `true` if the spy was called at least once with `obj` as `this`. `calledOn` also accepts a matcher `spyCall.calledOn(sinon.match(fn))` (see [matchers][matchers]).


#### `spy.alwaysCalledOn(obj);`
Expand Down Expand Up @@ -340,7 +340,7 @@ Returns `true` if spy always threw the provided exception object.

Returns `true` if spy returned the provided value at least once.

Uses deep comparison for objects and arrays. Use `spy.returned(sinon.match.same(obj))` for strict comparison (see [matchers](matchers)).
Uses deep comparison for objects and arrays. Use `spy.returned(sinon.match.same(obj))` for strict comparison (see [matchers][matchers]).


#### `spy.alwaysReturned(obj);`
Expand Down Expand Up @@ -426,3 +426,4 @@ Returns the passed format string with the following replacements performed:
</dl>

[call]: ../spy-call
[matchers]: ../matchers
6 changes: 4 additions & 2 deletions docs/_releases/latest/spy-call.md
Expand Up @@ -23,7 +23,7 @@ assertEquals("/stuffs", spyCall.args[0]);

### `spyCall.calledOn(obj);`

Returns `true` if `obj` was `this` for this call. `calledOn` also accepts a matcher `spyCall.calledOn(sinon.match(fn))` (see [matchers](matchers)).
Returns `true` if `obj` was `this` for this call. `calledOn` also accepts a matcher `spyCall.calledOn(sinon.match(fn))` (see [matchers][matchers]).


### `spyCall.calledWith(arg1, arg2, ...);`
Expand Down Expand Up @@ -56,7 +56,7 @@ This behaves the same as `spyCall.notCalledWith(sinon.match(arg1), sinon.match(a

Returns `true` if spied function returned the provided `value` on this call.

Uses deep comparison for objects and arrays. Use `spyCall.returned(sinon.match.same(obj))` for strict comparison (see [matchers](matchers)).
Uses deep comparison for objects and arrays. Use `spyCall.returned(sinon.match.same(obj))` for strict comparison (see [matchers][matchers]).

### `spyCall.threw();`

Expand Down Expand Up @@ -157,3 +157,5 @@ Exception thrown, if any.
### `spyCall.returnValue`

Return value.

[matchers]: ../matchers
4 changes: 3 additions & 1 deletion docs/_releases/latest/stubs.md
Expand Up @@ -135,7 +135,7 @@ Stubs the method only for the provided arguments.

This is useful to be more expressive in your assertions, where you can access the spy with the same call. It is also useful to create a stub that can act differently in response to different arguments.

Uses deep comparison for objects and arrays. Use `stub.withArgs(sinon.match.same(obj))` for strict comparison (see [matchers](matchers)).
Uses deep comparison for objects and arrays. Use `stub.withArgs(sinon.match.same(obj))` for strict comparison (see [matchers][matchers]).

<div data-example-id="stubs-2-different-args"></div>

Expand Down Expand Up @@ -527,3 +527,5 @@ You can restore values by calling the `restore` method:

Holds a reference to the original method/function this stub has
wrapped. `undefined` for the property accessors.

[matchers]: ../matchers
5 changes: 3 additions & 2 deletions docs/_releases/v7.4.1/spies.md
Expand Up @@ -241,7 +241,7 @@ occurred between `anotherSpy` and `spy`.

#### `spy.calledOn(obj);`

Returns `true` if the spy was called at least once with `obj` as `this`. `calledOn` also accepts a matcher `spyCall.calledOn(sinon.match(fn))` (see [matchers](matchers)).
Returns `true` if the spy was called at least once with `obj` as `this`. `calledOn` also accepts a matcher `spyCall.calledOn(sinon.match(fn))` (see [matchers][matchers]).


#### `spy.alwaysCalledOn(obj);`
Expand Down Expand Up @@ -346,7 +346,7 @@ Returns `true` if spy always threw the provided exception object.

Returns `true` if spy returned the provided value at least once.

Uses deep comparison for objects and arrays. Use `spy.returned(sinon.match.same(obj))` for strict comparison (see [matchers](matchers)).
Uses deep comparison for objects and arrays. Use `spy.returned(sinon.match.same(obj))` for strict comparison (see [matchers][matchers]).


#### `spy.alwaysReturned(obj);`
Expand Down Expand Up @@ -436,3 +436,4 @@ Returns the passed format string with the following replacements performed:
</dl>

[call]: ../spy-call
[matchers]: ../matchers
6 changes: 4 additions & 2 deletions docs/_releases/v7.4.1/spy-call.md
Expand Up @@ -23,7 +23,7 @@ assertEquals("/stuffs", spyCall.args[0]);

### `spyCall.calledOn(obj);`

Returns `true` if `obj` was `this` for this call. `calledOn` also accepts a matcher `spyCall.calledOn(sinon.match(fn))` (see [matchers](matchers)).
Returns `true` if `obj` was `this` for this call. `calledOn` also accepts a matcher `spyCall.calledOn(sinon.match(fn))` (see [matchers][matchers]).


### `spyCall.calledWith(arg1, arg2, ...);`
Expand Down Expand Up @@ -56,7 +56,7 @@ This behaves the same as `spyCall.notCalledWith(sinon.match(arg1), sinon.match(a

Returns `true` if spied function returned the provided `value` on this call.

Uses deep comparison for objects and arrays. Use `spyCall.returned(sinon.match.same(obj))` for strict comparison (see [matchers](matchers)).
Uses deep comparison for objects and arrays. Use `spyCall.returned(sinon.match.same(obj))` for strict comparison (see [matchers][matchers]).

### `spyCall.threw();`

Expand Down Expand Up @@ -143,3 +143,5 @@ Exception thrown, if any.
### `spyCall.returnValue`

Return value.

[matchers]: ../matchers
5 changes: 3 additions & 2 deletions docs/_releases/v7.4.2/spies.md
Expand Up @@ -241,7 +241,7 @@ occurred between `anotherSpy` and `spy`.

#### `spy.calledOn(obj);`

Returns `true` if the spy was called at least once with `obj` as `this`. `calledOn` also accepts a matcher `spyCall.calledOn(sinon.match(fn))` (see [matchers](matchers)).
Returns `true` if the spy was called at least once with `obj` as `this`. `calledOn` also accepts a matcher `spyCall.calledOn(sinon.match(fn))` (see [matchers][matchers]).


#### `spy.alwaysCalledOn(obj);`
Expand Down Expand Up @@ -346,7 +346,7 @@ Returns `true` if spy always threw the provided exception object.

Returns `true` if spy returned the provided value at least once.

Uses deep comparison for objects and arrays. Use `spy.returned(sinon.match.same(obj))` for strict comparison (see [matchers](matchers)).
Uses deep comparison for objects and arrays. Use `spy.returned(sinon.match.same(obj))` for strict comparison (see [matchers][matchers]).


#### `spy.alwaysReturned(obj);`
Expand Down Expand Up @@ -436,3 +436,4 @@ Returns the passed format string with the following replacements performed:
</dl>

[call]: ../spy-call
[matchers]: ../matchers
6 changes: 4 additions & 2 deletions docs/_releases/v7.4.2/spy-call.md
Expand Up @@ -23,7 +23,7 @@ assertEquals("/stuffs", spyCall.args[0]);

### `spyCall.calledOn(obj);`

Returns `true` if `obj` was `this` for this call. `calledOn` also accepts a matcher `spyCall.calledOn(sinon.match(fn))` (see [matchers](matchers)).
Returns `true` if `obj` was `this` for this call. `calledOn` also accepts a matcher `spyCall.calledOn(sinon.match(fn))` (see [matchers][matchers]).


### `spyCall.calledWith(arg1, arg2, ...);`
Expand Down Expand Up @@ -56,7 +56,7 @@ This behaves the same as `spyCall.notCalledWith(sinon.match(arg1), sinon.match(a

Returns `true` if spied function returned the provided `value` on this call.

Uses deep comparison for objects and arrays. Use `spyCall.returned(sinon.match.same(obj))` for strict comparison (see [matchers](matchers)).
Uses deep comparison for objects and arrays. Use `spyCall.returned(sinon.match.same(obj))` for strict comparison (see [matchers][matchers]).

### `spyCall.threw();`

Expand Down Expand Up @@ -143,3 +143,5 @@ Exception thrown, if any.
### `spyCall.returnValue`

Return value.

[matchers]: ../matchers
5 changes: 3 additions & 2 deletions docs/_releases/v7.5.0/spies.md
Expand Up @@ -275,7 +275,7 @@ occurred between `anotherSpy` and `spy`.

#### `spy.calledOn(obj);`

Returns `true` if the spy was called at least once with `obj` as `this`. `calledOn` also accepts a matcher `spyCall.calledOn(sinon.match(fn))` (see [matchers](matchers)).
Returns `true` if the spy was called at least once with `obj` as `this`. `calledOn` also accepts a matcher `spyCall.calledOn(sinon.match(fn))` (see [matchers][matchers]).


#### `spy.alwaysCalledOn(obj);`
Expand Down Expand Up @@ -380,7 +380,7 @@ Returns `true` if spy always threw the provided exception object.

Returns `true` if spy returned the provided value at least once.

Uses deep comparison for objects and arrays. Use `spy.returned(sinon.match.same(obj))` for strict comparison (see [matchers](matchers)).
Uses deep comparison for objects and arrays. Use `spy.returned(sinon.match.same(obj))` for strict comparison (see [matchers][matchers]).


#### `spy.alwaysReturned(obj);`
Expand Down Expand Up @@ -470,3 +470,4 @@ Returns the passed format string with the following replacements performed:
</dl>

[call]: ../spy-call
[matchers]: ../matchers
6 changes: 4 additions & 2 deletions docs/_releases/v7.5.0/spy-call.md
Expand Up @@ -23,7 +23,7 @@ assertEquals("/stuffs", spyCall.args[0]);

### `spyCall.calledOn(obj);`

Returns `true` if `obj` was `this` for this call. `calledOn` also accepts a matcher `spyCall.calledOn(sinon.match(fn))` (see [matchers](matchers)).
Returns `true` if `obj` was `this` for this call. `calledOn` also accepts a matcher `spyCall.calledOn(sinon.match(fn))` (see [matchers][matchers]).


### `spyCall.calledWith(arg1, arg2, ...);`
Expand Down Expand Up @@ -56,7 +56,7 @@ This behaves the same as `spyCall.notCalledWith(sinon.match(arg1), sinon.match(a

Returns `true` if spied function returned the provided `value` on this call.

Uses deep comparison for objects and arrays. Use `spyCall.returned(sinon.match.same(obj))` for strict comparison (see [matchers](matchers)).
Uses deep comparison for objects and arrays. Use `spyCall.returned(sinon.match.same(obj))` for strict comparison (see [matchers][matchers]).

### `spyCall.threw();`

Expand Down Expand Up @@ -143,3 +143,5 @@ Exception thrown, if any.
### `spyCall.returnValue`

Return value.

[matchers]: ../matchers
5 changes: 3 additions & 2 deletions docs/_releases/v8.0.0/spies.md
Expand Up @@ -199,7 +199,7 @@ occurred between `anotherSpy` and `spy`.

#### `spy.calledOn(obj);`

Returns `true` if the spy was called at least once with `obj` as `this`. `calledOn` also accepts a matcher `spyCall.calledOn(sinon.match(fn))` (see [matchers](matchers)).
Returns `true` if the spy was called at least once with `obj` as `this`. `calledOn` also accepts a matcher `spyCall.calledOn(sinon.match(fn))` (see [matchers][matchers]).


#### `spy.alwaysCalledOn(obj);`
Expand Down Expand Up @@ -304,7 +304,7 @@ Returns `true` if spy always threw the provided exception object.

Returns `true` if spy returned the provided value at least once.

Uses deep comparison for objects and arrays. Use `spy.returned(sinon.match.same(obj))` for strict comparison (see [matchers](matchers)).
Uses deep comparison for objects and arrays. Use `spy.returned(sinon.match.same(obj))` for strict comparison (see [matchers][matchers]).


#### `spy.alwaysReturned(obj);`
Expand Down Expand Up @@ -388,3 +388,4 @@ Returns the passed format string with the following replacements performed:
</dl>

[call]: ../spy-call
[matchers]: ../matchers
6 changes: 4 additions & 2 deletions docs/_releases/v8.0.0/spy-call.md
Expand Up @@ -23,7 +23,7 @@ assertEquals("/stuffs", spyCall.args[0]);

### `spyCall.calledOn(obj);`

Returns `true` if `obj` was `this` for this call. `calledOn` also accepts a matcher `spyCall.calledOn(sinon.match(fn))` (see [matchers](matchers)).
Returns `true` if `obj` was `this` for this call. `calledOn` also accepts a matcher `spyCall.calledOn(sinon.match(fn))` (see [matchers][matchers]).


### `spyCall.calledWith(arg1, arg2, ...);`
Expand Down Expand Up @@ -56,7 +56,7 @@ This behaves the same as `spyCall.notCalledWith(sinon.match(arg1), sinon.match(a

Returns `true` if spied function returned the provided `value` on this call.

Uses deep comparison for objects and arrays. Use `spyCall.returned(sinon.match.same(obj))` for strict comparison (see [matchers](matchers)).
Uses deep comparison for objects and arrays. Use `spyCall.returned(sinon.match.same(obj))` for strict comparison (see [matchers][matchers]).

### `spyCall.threw();`

Expand Down Expand Up @@ -143,3 +143,5 @@ Exception thrown, if any.
### `spyCall.returnValue`

Return value.

[matchers]: ../matchers
5 changes: 3 additions & 2 deletions docs/_releases/v8.0.1/spies.md
Expand Up @@ -199,7 +199,7 @@ occurred between `anotherSpy` and `spy`.

#### `spy.calledOn(obj);`

Returns `true` if the spy was called at least once with `obj` as `this`. `calledOn` also accepts a matcher `spyCall.calledOn(sinon.match(fn))` (see [matchers](matchers)).
Returns `true` if the spy was called at least once with `obj` as `this`. `calledOn` also accepts a matcher `spyCall.calledOn(sinon.match(fn))` (see [matchers][matchers]).


#### `spy.alwaysCalledOn(obj);`
Expand Down Expand Up @@ -304,7 +304,7 @@ Returns `true` if spy always threw the provided exception object.

Returns `true` if spy returned the provided value at least once.

Uses deep comparison for objects and arrays. Use `spy.returned(sinon.match.same(obj))` for strict comparison (see [matchers](matchers)).
Uses deep comparison for objects and arrays. Use `spy.returned(sinon.match.same(obj))` for strict comparison (see [matchers][matchers]).


#### `spy.alwaysReturned(obj);`
Expand Down Expand Up @@ -388,3 +388,4 @@ Returns the passed format string with the following replacements performed:
</dl>

[call]: ../spy-call
[matchers]: ../matchers
6 changes: 4 additions & 2 deletions docs/_releases/v8.0.1/spy-call.md
Expand Up @@ -23,7 +23,7 @@ assertEquals("/stuffs", spyCall.args[0]);

### `spyCall.calledOn(obj);`

Returns `true` if `obj` was `this` for this call. `calledOn` also accepts a matcher `spyCall.calledOn(sinon.match(fn))` (see [matchers](matchers)).
Returns `true` if `obj` was `this` for this call. `calledOn` also accepts a matcher `spyCall.calledOn(sinon.match(fn))` (see [matchers][matchers]).


### `spyCall.calledWith(arg1, arg2, ...);`
Expand Down Expand Up @@ -56,7 +56,7 @@ This behaves the same as `spyCall.notCalledWith(sinon.match(arg1), sinon.match(a

Returns `true` if spied function returned the provided `value` on this call.

Uses deep comparison for objects and arrays. Use `spyCall.returned(sinon.match.same(obj))` for strict comparison (see [matchers](matchers)).
Uses deep comparison for objects and arrays. Use `spyCall.returned(sinon.match.same(obj))` for strict comparison (see [matchers][matchers]).

### `spyCall.threw();`

Expand Down Expand Up @@ -143,3 +143,5 @@ Exception thrown, if any.
### `spyCall.returnValue`

Return value.

[matchers]: ../matchers
5 changes: 3 additions & 2 deletions docs/_releases/v8.0.2/spies.md
Expand Up @@ -233,7 +233,7 @@ occurred between `anotherSpy` and `spy`.

#### `spy.calledOn(obj);`

Returns `true` if the spy was called at least once with `obj` as `this`. `calledOn` also accepts a matcher `spyCall.calledOn(sinon.match(fn))` (see [matchers](matchers)).
Returns `true` if the spy was called at least once with `obj` as `this`. `calledOn` also accepts a matcher `spyCall.calledOn(sinon.match(fn))` (see [matchers][matchers]).


#### `spy.alwaysCalledOn(obj);`
Expand Down Expand Up @@ -338,7 +338,7 @@ Returns `true` if spy always threw the provided exception object.

Returns `true` if spy returned the provided value at least once.

Uses deep comparison for objects and arrays. Use `spy.returned(sinon.match.same(obj))` for strict comparison (see [matchers](matchers)).
Uses deep comparison for objects and arrays. Use `spy.returned(sinon.match.same(obj))` for strict comparison (see [matchers][matchers]).


#### `spy.alwaysReturned(obj);`
Expand Down Expand Up @@ -422,3 +422,4 @@ Returns the passed format string with the following replacements performed:
</dl>

[call]: ../spy-call
[matchers]: ../matchers
6 changes: 4 additions & 2 deletions docs/_releases/v8.0.2/spy-call.md
Expand Up @@ -23,7 +23,7 @@ assertEquals("/stuffs", spyCall.args[0]);

### `spyCall.calledOn(obj);`

Returns `true` if `obj` was `this` for this call. `calledOn` also accepts a matcher `spyCall.calledOn(sinon.match(fn))` (see [matchers](matchers)).
Returns `true` if `obj` was `this` for this call. `calledOn` also accepts a matcher `spyCall.calledOn(sinon.match(fn))` (see [matchers][matchers]).


### `spyCall.calledWith(arg1, arg2, ...);`
Expand Down Expand Up @@ -56,7 +56,7 @@ This behaves the same as `spyCall.notCalledWith(sinon.match(arg1), sinon.match(a

Returns `true` if spied function returned the provided `value` on this call.

Uses deep comparison for objects and arrays. Use `spyCall.returned(sinon.match.same(obj))` for strict comparison (see [matchers](matchers)).
Uses deep comparison for objects and arrays. Use `spyCall.returned(sinon.match.same(obj))` for strict comparison (see [matchers][matchers]).

### `spyCall.threw();`

Expand Down Expand Up @@ -143,3 +143,5 @@ Exception thrown, if any.
### `spyCall.returnValue`

Return value.

[matchers]: ../matchers
5 changes: 3 additions & 2 deletions docs/_releases/v8.0.3/spies.md
Expand Up @@ -233,7 +233,7 @@ occurred between `anotherSpy` and `spy`.

#### `spy.calledOn(obj);`

Returns `true` if the spy was called at least once with `obj` as `this`. `calledOn` also accepts a matcher `spyCall.calledOn(sinon.match(fn))` (see [matchers](matchers)).
Returns `true` if the spy was called at least once with `obj` as `this`. `calledOn` also accepts a matcher `spyCall.calledOn(sinon.match(fn))` (see [matchers][matchers]).


#### `spy.alwaysCalledOn(obj);`
Expand Down Expand Up @@ -338,7 +338,7 @@ Returns `true` if spy always threw the provided exception object.

Returns `true` if spy returned the provided value at least once.

Uses deep comparison for objects and arrays. Use `spy.returned(sinon.match.same(obj))` for strict comparison (see [matchers](matchers)).
Uses deep comparison for objects and arrays. Use `spy.returned(sinon.match.same(obj))` for strict comparison (see [matchers][matchers]).


#### `spy.alwaysReturned(obj);`
Expand Down Expand Up @@ -422,3 +422,4 @@ Returns the passed format string with the following replacements performed:
</dl>

[call]: ../spy-call
[matchers]: ../matchers

0 comments on commit 28e64b1

Please sign in to comment.