doc: shard not supported with watch mode

PR-URL: #50640 Reviewed-By: Raz Luvaton <[email protected]> Reviewed-By: Moshe Atlow <[email protected]>
nodejs · Nov 23, 2023 · f9675e1 · f9675e1
1 parent ea88a3e
commit f9675e1
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';