docs: shard not supported with watch mode

nodejs · Nov 20, 2023 · 63742cf · 63742cf
1 parent 5b73da0
commit 63742cf
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/doc/api/test.md b/doc/api/test.md
@@ -1142,6 +1142,11 @@ changes:
       of shards to split the test files to. This option is _required_.
 * Returns: {TestsStream}
 
+**Note:** `shard` is used to horizontally parallelize test running across
+machines or processes, ideal for large-scale executions across varied
+environments. It's incompatible with `watch` mode, tailored for rapid
+code iteration by automatically rerunning tests on file changes.
+
 ```mjs
 import { tap } from 'node:test/reporters';
 import { run } from 'node:test';