doc: clarify the exit code part of writing_tests

PR-URL: #9502 Reviewed-By: Santiago Gimeno <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
nodejs · Dec 13, 2016 · 1e06ed7 · 1e06ed7
1 parent 3f39a39
commit 1e06ed7
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/doc/guides/writing_tests.md b/doc/guides/writing_tests.md
@@ -3,11 +3,13 @@
 ## What is a test?
 
 A test must be a node script that exercises a specific functionality provided
-by node and checks that it behaves as expected. It should return 0 on success,
+by node and checks that it behaves as expected. It should exit with code `0` on success,
 otherwise it will fail. A test will fail if:
 
-- It exits by calling `process.exit(code)` where `code != 0`
-- It exits due to an uncaught exception.
+- It exits by setting `process.exitCode` to a non-zero number.
+  - This is most often done by having an assertion throw an uncaught
+    Error.
+  - Occasionally, using `process.exit(code)` may be appropriate.
 - It never exits. In this case, the test runner will terminate the test because
   it sets a maximum time limit.