From b86470fb7ab5eaf04384c76792086c42ed1e7f65 Mon Sep 17 00:00:00 2001 From: Shrujal Shah Date: Tue, 27 Jun 2023 02:15:23 +0000 Subject: [PATCH 1/4] doc: update return type for describe --- doc/api/test.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/test.md b/doc/api/test.md index 1df555a8274894..c3f8bf56caf49c 100644 --- a/doc/api/test.md +++ b/doc/api/test.md @@ -981,7 +981,7 @@ same as [`test([name], { only: true }[, fn])`][it options]. declaring all subtests and subsuites. The first argument to this function is a [`SuiteContext`][] object. **Default:** A no-op function. -* Returns: `undefined`. +* Returns: {Promise} Resolved with `undefined`. The `describe()` function imported from the `node:test` module. Each invocation of this function results in the creation of a Subtest. From f133380ab375bdf8d355a5f4a9f9250c9803b38a Mon Sep 17 00:00:00 2001 From: Shrujal Shah Date: Tue, 27 Jun 2023 10:30:19 +0100 Subject: [PATCH 2/4] Update doc/api/test.md Co-authored-by: Moshe Atlow --- doc/api/test.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/test.md b/doc/api/test.md index c3f8bf56caf49c..e70802618fb9d2 100644 --- a/doc/api/test.md +++ b/doc/api/test.md @@ -981,7 +981,7 @@ same as [`test([name], { only: true }[, fn])`][it options]. declaring all subtests and subsuites. The first argument to this function is a [`SuiteContext`][] object. **Default:** A no-op function. -* Returns: {Promise} Resolved with `undefined`. +* Returns: {Promise} Immideatly resolved with `undefined`. The `describe()` function imported from the `node:test` module. Each invocation of this function results in the creation of a Subtest. From 1f63560a1771229e32aa20ca9346ab5ae851f708 Mon Sep 17 00:00:00 2001 From: Shrujal Shah Date: Tue, 27 Jun 2023 14:08:14 +0100 Subject: [PATCH 3/4] Update doc/api/test.md Co-authored-by: Shiba <128208841+HinataKah0@users.noreply.github.com> --- doc/api/test.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/test.md b/doc/api/test.md index e70802618fb9d2..4cdee393d6f599 100644 --- a/doc/api/test.md +++ b/doc/api/test.md @@ -981,7 +981,7 @@ same as [`test([name], { only: true }[, fn])`][it options]. declaring all subtests and subsuites. The first argument to this function is a [`SuiteContext`][] object. **Default:** A no-op function. -* Returns: {Promise} Immideatly resolved with `undefined`. +* Returns: {Promise} Immediately resolved with `undefined`. The `describe()` function imported from the `node:test` module. Each invocation of this function results in the creation of a Subtest. From 901ece41efab0815a69dabae258a028844957d15 Mon Sep 17 00:00:00 2001 From: Shrujal Shah Date: Wed, 28 Jun 2023 10:35:24 +0100 Subject: [PATCH 4/4] Update doc/api/test.md Co-authored-by: Benjamin Gruenbaum --- doc/api/test.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/test.md b/doc/api/test.md index 4cdee393d6f599..d3d7ed8086fae1 100644 --- a/doc/api/test.md +++ b/doc/api/test.md @@ -981,7 +981,7 @@ same as [`test([name], { only: true }[, fn])`][it options]. declaring all subtests and subsuites. The first argument to this function is a [`SuiteContext`][] object. **Default:** A no-op function. -* Returns: {Promise} Immediately resolved with `undefined`. +* Returns: {Promise} Immediately fulfilled with `undefined`. The `describe()` function imported from the `node:test` module. Each invocation of this function results in the creation of a Subtest.