aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Colin McDonnell <colinmcd94@gmail.com> 2023-07-17 11:42:06 -0700
committerGravatar Colin McDonnell <colinmcd94@gmail.com> 2023-07-17 11:42:13 -0700
commit8a176913d8caf097c90008bad4ebc3dbac8df477 (patch)
tree1202c564b83ec789525e04100937e85545f6417f
parent570a44d73a14b73614d6bdd8787f08545dd63c37 (diff)
downloadbun-8a176913d8caf097c90008bad4ebc3dbac8df477.tar.gz
bun-8a176913d8caf097c90008bad4ebc3dbac8df477.tar.zst
bun-8a176913d8caf097c90008bad4ebc3dbac8df477.zip
Tweak test docs
-rw-r--r--docs/runtime/hot.md5
-rw-r--r--docs/test/writing.md2
2 files changed, 3 insertions, 4 deletions
diff --git a/docs/runtime/hot.md b/docs/runtime/hot.md
index d68a9ebea..0797187de 100644
--- a/docs/runtime/hot.md
+++ b/docs/runtime/hot.md
@@ -7,7 +7,6 @@ Bun supports two kinds of automatic reloading via CLI flags:
Watch mode can be used with `bun test` or when running TypeScript, JSX, and JavaScript files.
-
To run a file in `--watch` mode:
```bash
@@ -17,7 +16,7 @@ $ bun --watch index.tsx
To run your tests in `--watch` mode:
```bash
-$ bun --watch test
+$ bun --watch test
```
In `--watch` mode, Bun keeps track of all imported files and watches them for changes. When a change is detected, Bun restarts the process, preserving the same set of CLI arguments and environment variables used in the initial run. If Bun crashes, `--watch` will attempt to automatically restart the process.
@@ -58,7 +57,7 @@ serve({
Running `bun test` in watch mode and `save-on-keypress` enabled:
```bash
-$ bun --watch test
+$ bun --watch test
```
![bun test gif](https://user-images.githubusercontent.com/709451/228396976-38a23864-4a1d-4c96-87cc-04e5181bf459.gif)
diff --git a/docs/test/writing.md b/docs/test/writing.md
index 6a29bf81f..e5e3fe1b0 100644
--- a/docs/test/writing.md
+++ b/docs/test/writing.md
@@ -70,7 +70,7 @@ Optionally specify a per-test timeout in milliseconds by passing a number as the
```ts
import { test } from "bun:test";
-test.skip("wat", async () => {
+test("wat", async () => {
const data = await slowOperation();
expect(data).toBe(42);
}, 500); // test must run in <500ms