Skip to content
This repository was archived by the owner on Jan 26, 2025. It is now read-only.

Commit 6ff4f8e

Browse files
swaitstingerrr
authored andcommitted
docs: edit notes in Watching guide, format as a warning
1 parent d7d0c8f commit 6ff4f8e

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

docs/book/src/guides/watching.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,21 @@ watchexec \
1717
"typst-test r"
1818
```
1919

20-
This will run `typst-test r` whenever any file changes other than those in your tests' `{diff,out}` directories.
21-
2220
You may create an alias in your shell to make it more convenient:
2321

2422
```bash
2523
alias ttw="watchexec --watch . --clear --ignore 'tests/**/diff/**' --ignore 'tests/**/out/**' 'typst-test r'"
2624
```
2725

28-
Note, if your tests change any files in your package source tree, you may need to include them as additional `--ignore <glob>` patterns to the command.
26+
This will automatically run `typst-test r` whenever any file changes other than those in your tests' `{diff,out}` directories.
27+
28+
<div class="warning">
29+
30+
Notes:
31+
32+
1. The command we're using here, using `typst-test r`, runs all tests anytime any file changes.
33+
If you want different behavior, you need to modify the command appropriately.
34+
35+
2. Although unlikely, if your tests change any files in your package source tree, you may need to include them as additional `--ignore <glob>` patterns to the command.
36+
37+
</div>

0 commit comments

Comments
 (0)