Docs: Add example showcasing what modules do to test names

qunitjs · Jul 18, 2024 · 4d672bc · 4d672bc
1 parent 9992fa4
commit 4d672bc
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 3 deletions.
diff --git a/docs/api/QUnit/module.md b/docs/api/QUnit/module.md
@@ -74,13 +74,20 @@ The module scope is given a `hooks` object which can be used to add [hooks](#hoo
 Example:
 
 ```js
+// Fruit > Berries > cowberry.
+// Fruit > Berries > cranberry.
+// Fruit > Melons > galia.
+// Bread > bake.
+// Bread > toast.
 QUnit.module('Fruit', function (hooks) {
   QUnit.module('Berries', function (hooks) {
-    QUnit.test('cranberry', function (assert) {
+    QUnit.test('cowberry', function (assert) {
       assert.true(true);
     });
 
-    // ...
+    QUnit.test('cranberry', function (assert) {
+      assert.true(true);
+    });
   });
 
   QUnit.module('Melons', function (hooks) {

diff --git a/docs/intro.md b/docs/intro.md
@@ -84,5 +84,5 @@ These are the official release channels for QUnit releases:
 
 ## Further reading
 
-* [Rad QUnit documentation offline](https://devdocs.io/qunit/), via DevDocs.
+* [Read QUnit documentation offline](https://devdocs.io/qunit/), via DevDocs.
 * [Introduction to JavaScript Unit Testing](https://coding.smashingmagazine.com/2012/06/introduction-to-javascript-unit-testing/), Jörn Zaefferer (2012).