Skip to content

Commit 34abead

Browse files
committed
doc: Remove @example JS Doc
because it's not part of our JS Doc pattern
1 parent 915c6dd commit 34abead

File tree

3 files changed

+0
-6
lines changed

3 files changed

+0
-6
lines changed

src/matchers/toChange.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
/**
22
* Use `.toChange` when checking if a value has changed.
3-
* @example
4-
* expect(() => value--).toChange(() => value);
53
*/
64
export function toChange(mutator: () => unknown | void, checker: () => number) {
75
// @ts-expect-error OK to have implicit any for this.utils

src/matchers/toChangeBy.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
/**
22
* Use `.toChangeBy` when checking if a value changed by an amount.
3-
* @example
4-
* expect(() => value--).toChangeBy(() => value, -1);
53
*/
64
export function toChangeBy(mutator: () => unknown | void, checker: () => number, by: number = 1) {
75
// @ts-expect-error OK to have implicit any for this.utils

src/matchers/toChangeTo.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
/**
22
* Use `.toChangeTo` when checking if a value changed to a specific value.
3-
* @example
4-
* expect(() => Model.deleteAll()).toChangeTo(() => Model.count(), 0);
53
*/
64
export function toChangeTo(mutator: () => unknown | void, checker: () => number, to: number) {
75
// @ts-expect-error OK to have implicit any for this.utils

0 commit comments

Comments
 (0)