From 1a23c68c3afd9fda94c88b7f04de39a3de7f18dc Mon Sep 17 00:00:00 2001
From: Ognjen Jevremovic <jevremovic.ognjen@gmail.com>
Date: Fri, 19 Jan 2024 11:58:11 +0100
Subject: [PATCH 1/5] doc: clarify execution of `after` hook on test suite
 completion

The `after` hook now explicitly mentions that it is executed once after
all the tests in a test suite have completed, regardless of whether the
tests passed or failed. This ensures that cleanup tasks or actions
specified in the after hook are guaranteed to run.

Refs: https://github.com/nodejs/node/issues/50901
---
 doc/api/test.md | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/doc/api/test.md b/doc/api/test.md
index 5f2d3dfad56cd0..05c8c901a56b4f 100644
--- a/doc/api/test.md
+++ b/doc/api/test.md
@@ -1420,6 +1420,13 @@ describe('tests', async () => {
 });
 ```
 
+**Note:** The `after` hook is executed once after all the tests
+in a test suite have completed, regardless of whether the tests
+passed or failed. This hook is useful for performing cleanup tasks
+or actions that should occur after the entire test suite has been run.
+It's important to note that the `after` hook is guaranteed to run,
+even if tests within the suite fail.
+
 ## `beforeEach([fn][, options])`
 
 <!-- YAML

From 19da2290e0545c2a76dcfb768dec6be9901ce25e Mon Sep 17 00:00:00 2001
From: Ognjen Jevremovic <jevremovic.ognjen@gmail.com>
Date: Fri, 19 Jan 2024 12:00:43 +0100
Subject: [PATCH 2/5] doc: clarify execution of `afterEach` hook after each
 test

The `afterEach` hook is now documented to be executed after each
individual test in a test suite, irrespective of whether the test passed
or failed. Developers can rely on this hook for performing cleanup or
resetting state after each test.

Refs: https://github.com/nodejs/node/issues/50901
---
 doc/api/test.md | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/doc/api/test.md b/doc/api/test.md
index 05c8c901a56b4f..ee84e447bbee24 100644
--- a/doc/api/test.md
+++ b/doc/api/test.md
@@ -1480,6 +1480,12 @@ added:
 This function is used to create a hook running
 after each subtest of the current test.
 
+**Note:** The `afterEach` hook is executed after each individual test
+in a test suite, regardless of whether the test passed or failed.
+This hook is commonly used for cleaning up resources or resetting state
+between tests. It's important to note that the `afterEach` hook
+is guaranteed to run after every test, even if any of the tests fail.
+
 ```js
 describe('tests', async () => {
   afterEach(() => console.log('finished running a test'));

From 669ccaa6987454f9ce492c59b0a08a35ef9af2bd Mon Sep 17 00:00:00 2001
From: Ognjen Jevremovic <jevremovic.ognjen@gmail.com>
Date: Fri, 19 Jan 2024 12:24:41 +0100
Subject: [PATCH 3/5] doc: improve clarity in after and afterEach hook
 documentation

Refined the language in the documentation for the `after` and
`afterEach`
hooks to enhance clarity. Replaced instances of "note that" with more
direct and concise language for better readability.

Refs: https://github.com/nodejs/node/issues/50901
---
 doc/api/test.md | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/doc/api/test.md b/doc/api/test.md
index ee84e447bbee24..f4937cd36e200b 100644
--- a/doc/api/test.md
+++ b/doc/api/test.md
@@ -1424,8 +1424,7 @@ describe('tests', async () => {
 in a test suite have completed, regardless of whether the tests
 passed or failed. This hook is useful for performing cleanup tasks
 or actions that should occur after the entire test suite has been run.
-It's important to note that the `after` hook is guaranteed to run,
-even if tests within the suite fail.
+The `after` hook is guaranteed to run, even if tests within the suite fail.
 
 ## `beforeEach([fn][, options])`
 
@@ -1483,8 +1482,8 @@ after each subtest of the current test.
 **Note:** The `afterEach` hook is executed after each individual test
 in a test suite, regardless of whether the test passed or failed.
 This hook is commonly used for cleaning up resources or resetting state
-between tests. It's important to note that the `afterEach` hook
-is guaranteed to run after every test, even if any of the tests fail.
+between tests. The `afterEach` hook is guaranteed to run after every test,
+even if any of the tests fail.
 
 ```js
 describe('tests', async () => {

From 8a1bedd3cf1540bbbb461358ef7ec85a48c957d4 Mon Sep 17 00:00:00 2001
From: Ognjen Jevremovic <jevremovic.ognjen@gmail.com>
Date: Sat, 20 Jan 2024 11:58:03 +0100
Subject: [PATCH 4/5] doc: improve clarity in after and afterEach hook
 documentation

Refined the documentation for the `after` and `afterEach` hooks to
enhance clarity. Removed redundant information and retained the
essential details. The revised note now explicitly states that the
`after` and `afterEach` hooks are guaranteed to run, even if tests
within the suite fail.

Refs: https://github.com/nodejs/node/issues/50901
---
 doc/api/test.md | 11 ++---------
 1 file changed, 2 insertions(+), 9 deletions(-)

diff --git a/doc/api/test.md b/doc/api/test.md
index f4937cd36e200b..73f4851b1fe0ec 100644
--- a/doc/api/test.md
+++ b/doc/api/test.md
@@ -1420,11 +1420,7 @@ describe('tests', async () => {
 });
 ```
 
-**Note:** The `after` hook is executed once after all the tests
-in a test suite have completed, regardless of whether the tests
-passed or failed. This hook is useful for performing cleanup tasks
-or actions that should occur after the entire test suite has been run.
-The `after` hook is guaranteed to run, even if tests within the suite fail.
+**Note:** The `after` hook is guaranteed to run, even if tests within the suite fail.
 
 ## `beforeEach([fn][, options])`
 
@@ -1479,10 +1475,7 @@ added:
 This function is used to create a hook running
 after each subtest of the current test.
 
-**Note:** The `afterEach` hook is executed after each individual test
-in a test suite, regardless of whether the test passed or failed.
-This hook is commonly used for cleaning up resources or resetting state
-between tests. The `afterEach` hook is guaranteed to run after every test,
+**Note:** The `afterEach` hook is guaranteed to run after every test,
 even if any of the tests fail.
 
 ```js

From 4311384b6347491c0c80e97296d393e43d68f07e Mon Sep 17 00:00:00 2001
From: Ognjen Jevremovic <jevremovic.ognjen@gmail.com>
Date: Sat, 20 Jan 2024 13:16:48 +0100
Subject: [PATCH 5/5] doc: address line length linting error in documentation

Adjusted line lengths in the documentation to adhere to the maximum
allowed limit of 80 characters. This change resolves the linting error.

Refs: https://github.com/nodejs/node/issues/50901
---
 doc/api/test.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/doc/api/test.md b/doc/api/test.md
index 73f4851b1fe0ec..bb26b5eb8b92c5 100644
--- a/doc/api/test.md
+++ b/doc/api/test.md
@@ -1420,7 +1420,8 @@ describe('tests', async () => {
 });
 ```
 
-**Note:** The `after` hook is guaranteed to run, even if tests within the suite fail.
+**Note:** The `after` hook is guaranteed to run,
+even if tests within the suite fail.
 
 ## `beforeEach([fn][, options])`