Skip to content

Commit d060f13

Browse files
authored
update documentation for Documentation Tests (#1376)
1 parent 8b1df4b commit d060f13

File tree

1 file changed

+3
-11
lines changed

1 file changed

+3
-11
lines changed

runtime/reference/documentation.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,7 @@ title: "Documentation Tests"
33
oldUrl: /runtime/manual/testing/documentation/
44
---
55

6-
Deno supports _type-checking_ your documentation examples.
7-
8-
:::info
9-
10-
No runtime behavior is tested for code snippets in documentation as of now.
11-
Tracking issue:
12-
[denoland/deno#4716](https://github.com/denoland/deno/issues/4716)
13-
14-
:::
6+
Deno supports both type-checking evaluating your documentation examples.
157

168
This makes sure that examples within your documentation are up to date and
179
working.
@@ -60,8 +52,8 @@ type-checking the code block.
6052
````
6153

6254
If this example was in a file named foo.ts, running `deno test --doc foo.ts`
63-
will extract this example, and then type-check it as a standalone module living
64-
in the same directory as the module being documented.
55+
will extract this example, and then both type-check and evaluate it as a
56+
standalone module living in the same directory as the module being documented.
6557

6658
To document your exports, import the module using a relative path specifier:
6759

0 commit comments

Comments
 (0)