Skip to content

Commit 1f48367

Browse files
authored
test(testing): ignore doc test of snapshot docs (#6718)
1 parent 9849110 commit 1f48367

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

testing/snapshot.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
* to a reference snapshot, which is stored alongside the test file in the
77
* `__snapshots__` directory.
88
*
9-
* ```ts
9+
* ```ts ignore
1010
* // example_test.ts
1111
* import { assertSnapshot } from "@std/testing/snapshot";
1212
*
@@ -34,7 +34,7 @@
3434
* The `assertInlineSnapshot` function will create a snapshot of a value and compare it
3535
* to a reference snapshot, which is stored in the test file.
3636
*
37-
* ```ts
37+
* ```ts ignore
3838
* // example_test.ts
3939
* import { assertInlineSnapshot } from "@std/testing/unstable-snapshot";
4040
*
@@ -99,8 +99,8 @@
9999
* The `assertSnapshot` and `assertInlineSnapshot` functions optionally accept an
100100
* options object.
101101
*
102-
* ```ts
103-
* // example_test.ts
102+
* ```ts ignore
103+
* // example_test.ts ignore
104104
* import { assertSnapshot } from "@std/testing/snapshot";
105105
*
106106
* Deno.test("isSnapshotMatch", async function (t): Promise<void> {
@@ -137,7 +137,7 @@
137137
* It is possible to "extend" an `assertSnapshot` or `assertInlineSnapshot` function which
138138
* has been configured with default options.
139139
*
140-
* ```ts
140+
* ```ts ignore
141141
* // example_test.ts
142142
* import { createAssertSnapshot } from "@std/testing/snapshot";
143143
* import { stripAnsiCode } from "@std/fmt/colors";
@@ -507,7 +507,7 @@ class AssertSnapshotContext {
507507
* Type parameter can be specified to ensure values under comparison have the same type.
508508
*
509509
* @example Usage
510-
* ```ts
510+
* ```ts ignore
511511
* import { assertSnapshot } from "@std/testing/snapshot";
512512
*
513513
* Deno.test("snapshot", async (t) => {
@@ -531,7 +531,7 @@ export async function assertSnapshot<T>(
531531
* Type parameter can be specified to ensure values under comparison have the same type.
532532
*
533533
* @example Usage
534-
* ```ts
534+
* ```ts ignore
535535
* import { assertSnapshot } from "@std/testing/snapshot";
536536
*
537537
* Deno.test("snapshot", async (t) => {
@@ -613,7 +613,7 @@ export async function assertSnapshot(
613613
* The specified option becomes the default for returned {@linkcode assertSnapshot}
614614
*
615615
* @example Usage
616-
* ```ts
616+
* ```ts ignore
617617
* import { createAssertSnapshot } from "@std/testing/snapshot";
618618
*
619619
* const assertSnapshot = createAssertSnapshot({

0 commit comments

Comments
 (0)