Skip to content

Commit

Permalink
update documentation for Documentation Tests
Browse files Browse the repository at this point in the history
denoland/deno#25220 completed this work
  • Loading branch information
JeremyLoy authored Jan 28, 2025
1 parent 87e5781 commit 72f4be0
Showing 1 changed file with 2 additions and 10 deletions.
12 changes: 2 additions & 10 deletions runtime/reference/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,7 @@ title: "Documentation Tests"
oldUrl: /runtime/manual/testing/documentation/
---

Deno supports _type-checking_ your documentation examples.

:::info

No runtime behavior is tested for code snippets in documentation as of now.
Tracking issue:
[denoland/deno#4716](https://github.com/denoland/deno/issues/4716)

:::
Deno supports both type-checking evaluating your documentation examples.

This makes sure that examples within your documentation are up to date and
working.
Expand Down Expand Up @@ -60,7 +52,7 @@ type-checking the code block.
````

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

To document your exports, import the module using a relative path specifier:
Expand Down

0 comments on commit 72f4be0

Please sign in to comment.