Docs: Minor improvements caught during review of 3.0 Upgrade Guide

Ref #1808.

Author: Krinkle

History.md

@@ -3,17 +3,11 @@
 
 ### Added
 
+* Release: Add native ESM distribution, used automatically by Node.js when using the `import` keyword. [#1551](https://github.com/qunitjs/qunit/issues/1551)
 * Core: Add module context to `before` and `after` hooks. This enables inheritance between parent and child modules, and fixes leaks between last test and `after` hooks. (Ray Cohen) [#1328](https://github.com/qunitjs/qunit/issues/1328)
 * Core: Add [`QUnit.config.reporters.html`](https://qunitjs.com/api/config/reporters/) for disabling the HTML Reporter. [#1711](https://github.com/qunitjs/qunit/issues/1711)
 * Core: Export [`QUnit.urlParams`](https://qunitjs.com/api/extension/QUnit.urlParams/) unconditionally. [57c2dbcffc](https://github.com/Krinkle/qunit/commit/57c2dbcffc694bf3a0b5d1d57e7f43f16ff29862)
 * Core: Export `QUnit` global unconditionally. [#1771](https://github.com/qunitjs/qunit/pull/1771)
-* Release: Add native ESM distribution. [#1551](https://github.com/qunitjs/qunit/issues/1551)
-
-  This introduces an ESM distribution (`qunit/esm/qunit.module.js`), alongside the existing `qunit/qunit.js` file in the CJS format. Both are available for [download](https://releases.jquery.com/qunit/).
-
-  Browser support for the CJS format is the same as in QUnit 2.x (including IE 9-11 and Safari 7+). If you choose to opt-in to the ESM format, note that this does not support running tests in IE 9-11 or Safari 7-9.
-
-  When testing in Node.js, we automatically select a format based on `require()` vs `import`. Both share the same instance internally so mixed usage is okay. If some configuration files, plugins, adapters, test runners, or tests import QUnit differently, everything still works fine.
 
 ### Changed
 
@@ -23,17 +17,17 @@
 * Core: Promote warning "[Unexpected test after runEnd](https://qunitjs.com/api/config/autostart/#E0001)" to error. [#1377](https://github.com/qunitjs/qunit/issues/1377)
 * Core: Promote "No tests were run." from fake test to native error. [#1790](https://github.com/qunitjs/qunit/pull/1790)
 * Assert: Change [`assert.expect()`](https://qunitjs.com/api/assert/expect/) to exclude `assert.step()` calls from count. (Kyle Simpson) [#1226](https://github.com/qunitjs/qunit/issues/1226)
-* HTML Reporter: New theme design and structure. Before and after demo in [#1774](https://github.com/qunitjs/qunit/pull/1774).
-  * Add support for displaying early errors in the UI. [#1786](https://github.com/qunitjs/qunit/pull/1786)
-  * Add `user-select: none;` to "Rerun" link and "runtime" indicator. [6becc199e0](https://github.com/qunitjs/qunit/commit/6becc199e0)
-  * Add `running` class to test items. [1551120536](https://github.com/qunitjs/qunit/commit/1551120536f6f572a3bb5656db566f0a1bb217d8)
+* HTML Reporter: New design with fresh color palette and improved color contrast. View demos in [#1774](https://github.com/qunitjs/qunit/pull/1774).
+  * Faster UI rendering, now instantly instead of after DOM-ready. [#1793](https://github.com/qunitjs/qunit/pull/1793)
+  * Faster headless execution, when [`id=qunit` element](https://qunitjs.com/browser/) does not exist. [#1711](https://github.com/qunitjs/qunit/issues/1711)
+  * Add support for displaying early errors. [#1786](https://github.com/qunitjs/qunit/pull/1786)
+  * Change assertion count in toolbar to test count. [#1760](https://github.com/qunitjs/qunit/pull/1760)
   * Change `#qunit-banner` from H2 to DIV, to fix WCAG compliance. [#1427](https://github.com/qunitjs/qunit/issues/1427)
   * Change `#qunit-testresult` from P to DIV, to fix HTML serialization. [#1301](https://github.com/qunitjs/qunit/issues/1301)
-  * Change run time in toolbar from milliseconds to seconds. [#1760](https://github.com/qunitjs/qunit/pull/1760)
-  * Faster UI rendering, now instantly instead of after DOM-ready. [#1793](https://github.com/qunitjs/qunit/pull/1793)
+  * Change runtime in toolbar from milliseconds to seconds. [#1760](https://github.com/qunitjs/qunit/pull/1760)
+  * Fix text selection to exclude "Rerun" link. [6becc199e0](https://github.com/qunitjs/qunit/commit/6becc199e0)
   * Fix overflow and scrollbar issues. [#1603](https://github.com/qunitjs/qunit/issues/1603)
-  * Fix HTML Reporter to have no overhead when no [`id=qunit` element](https://qunitjs.com/browser/) exists. [#1711](https://github.com/qunitjs/qunit/issues/1711)
-  * Remove assertion count from toolbar in favor of test count. [#1760](https://github.com/qunitjs/qunit/pull/1760)
+  * Fix adding `running` class to test items. [1551120536](https://github.com/qunitjs/qunit/commit/1551120536f6f572a3bb5656db566f0a1bb217d8)
 
 ### Fixed
 
@@ -47,7 +41,7 @@
 
 * Core: Remove support for Node.js 10-16. Node.js 18 or later is required. (NullVoxPopuli) [#1727](https://github.com/qunitjs/qunit/issues/1727)
 * Core: Remove support for PhantomJS. (Steve McClure) [#1505](https://github.com/qunitjs/qunit/pull/1505)
-* Core: Remove built-in export for AMD. You can still load your application and your QUnit tests with AMD/RequireJS. This only affects the loading of the qunit.js file itself. [Example: Loading with RequireJS](https://qunitjs.com/api/config/autostart/#loading-with-requirejs). (NullVoxPopuli) [#1729](https://github.com/qunitjs/qunit/issues/1729)
+* Core: Remove built-in export for AMD. You can continue to load your application and your QUnit tests with AMD/RequireJS. This change only affects the loading of the qunit.js file itself. [Example: Loading with RequireJS](https://qunitjs.com/api/config/autostart/#loading-with-requirejs). (NullVoxPopuli) [#1729](https://github.com/qunitjs/qunit/issues/1729)
 * Core: Remove deprecated [`QUnit.load()`](https://qunitjs.com/api/QUnit/load/). [#1084](https://github.com/qunitjs/qunit/issues/1084)
 * Core: Remove deprecated `QUnit.onError()` and `QUnit.onUnhandledRejection()` in favor of [`QUnit.onUncaughtException()`](https://qunitjs.com/api/extension/QUnit.onUncaughtException/).
 * Core: Remove undocumented `details.modules[].tests` from QUnit.begin() event.

docs/_posts/2020-11-29-qunit-2-13-0.md

@@ -19,7 +19,7 @@ Thanks Steve McClure, Stephen Yeung, and brandonocasey for their contributions!
 
 ### Deprecated
 
-* HTML Reporter: Deprecate PhantomJS. (Steve McClure)
+* HTML Reporter: Deprecate PhantomJS. (Steve McClure) [#1505](https://github.com/qunitjs/qunit/pull/1505)
 
 ### Fixed
 

docs/_sass/custom.scss

@@ -107,6 +107,10 @@ h3 a {
   }
 }
 
+.content li {
+  margin: 0.5em 0;
+}
+
 .content a.footnote {
   text-decoration: none;
 }

docs/api/QUnit/test.each.md

@@ -1,7 +1,7 @@
 ---
 layout: page-api
 title: QUnit.test.each()
-excerpt: Add tests using a data provider.
+excerpt: Define tests using a data provider.
 groups:
   - main
 redirect_from:

docs/api/QUnit/test.if.md

@@ -1,7 +1,7 @@
 ---
 layout: page-api
 title: QUnit.test.if()
-excerpt: Add a test that may be skipped.
+excerpt: Define a test that is automatically skipped when a condition is false.
 groups:
   - main
 redirect_from:
@@ -11,7 +11,7 @@ version_added: "2.22.0"
 
 `QUnit.test.if( name, condition, callback )`
 
-Add a test that only runs if a condition is true.
+Define a test that is automatically skipped when a condition is false.
 
 | parameter | description |
 |-----------|-------------|
@@ -21,7 +21,7 @@ Add a test that only runs if a condition is true.
 
 If the condition is true, this is equivalent to calling [`QUnit.test()`](./test.md).
 
-If the conditional is false, this is equivalent to calling [`QUnit.test.skip()`](./test.skip.md), and test will not run. Instead, it will be listed in the results as a "skipped" test.
+If the conditional is false, this is equivalent to calling [`QUnit.test.skip()`](./test.skip.md), and the test will not run. Instead, it will be listed in the results as a "skipped" test.
 
 Use cases:
 * Skip tests for a feature not supported in an older browser, when cross-browser testing in CI.

docs/api/QUnit/test.only.md

@@ -1,7 +1,7 @@
 ---
 layout: page-api
 title: QUnit.test.only()
-excerpt: Add a test that is exclusively run.
+excerpt: Define a test that is exclusively run.
 groups:
   - main
 redirect_from:
@@ -14,7 +14,7 @@ version_added: "1.20.0"
 `QUnit.test.only( name, callback )`<br>
 `QUnit.only( name, callback )`
 
-Add a test that is exclusively run, preventing other tests from running unless they are also defined in this way.
+Define a test that is exclusively run, preventing other tests from running unless they are also defined in this way.
 
 | parameter | description |
 |-----------|-------------|

docs/api/QUnit/test.skip.md

@@ -1,7 +1,7 @@
 ---
 layout: page-api
 title: QUnit.test.skip()
-excerpt: Add a test that will be skipped.
+excerpt: Define a test that will be skipped.
 groups:
   - main
 redirect_from:
@@ -16,7 +16,7 @@ version_added: "1.16.0"
 `QUnit.skip( name )`<br/>
 `QUnit.skip( name, callback )`
 
-Add a test that will be skipped during the run.
+Define a test that will be skipped during the run.
 
 | parameter | description |
 |-----------|-------------|

docs/api/QUnit/test.todo.md

@@ -1,7 +1,7 @@
 ---
 layout: page-api
 title: QUnit.test.todo()
-excerpt: Add a test which expects at least one failing assertion.
+excerpt: Define a test that is not yet expected to pass.
 groups:
   - main
 redirect_from:
@@ -14,7 +14,7 @@ version_added: "2.2.0"
 `QUnit.test.todo( name, callback )`<br>
 `QUnit.todo( name, callback )`
 
-Add a test which expects at least one failing assertion or exception during its run.
+Define a test that is not yet expected to pass, because the test has one or more failing assertions or throws an exception.
 
 | parameter | description |
 |-----------|-------------|

docs/api/assert/rejects.md

@@ -51,10 +51,11 @@ async function feedBaby (food) {
 }
 
 QUnit.test('example', async function (assert) {
-  await assert.rejects(
-    feedBaby('sprouts'),
-    RangeError
-  );
+  assert.true(feedBaby('apple'));
+
+  await assert.rejects(feedBaby('sprouts'), RangeError);
+
+  assert.true(feedBaby('cucumber'), RangeError);
 });
 ```
 

docs/api/assert/timeout.md

@@ -1,7 +1,7 @@
 ---
 layout: page-api
 title: assert.timeout()
-excerpt: How long to wait for async operations.
+excerpt: How long a test may spend in async operations.
 groups:
   - assert
   - async
@@ -12,7 +12,7 @@ version_added: "2.4.0"
 
 `timeout( duration )`
 
-Set how long to wait for async operations to finish.
+Set how long a test may wait for async operations to finish.
 
 | name | description |
 |------|-------------|