doc: explain how suites and subtests differ#63962
Open
emmayusufu wants to merge 1 commit into
Open
Conversation
The test runner documentation describes suites and tests with subtests separately, and the Subtests section already notes that the two await their children differently. It never explains how they otherwise differ. This adds a short "Suites versus subtests" section that shows the two equivalent forms together and lists the differences: the context object each callback receives, how their children are awaited, and what each returns. Fixes: nodejs#60758 Signed-off-by: Emmanuel Yusufu Kimaswa <kimaswaemma36@gmail.com>
Collaborator
|
Review requested:
|
nodejs-github-bot
added
doc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The test runner docs document
suite()and tests with subtestsseparately, and the Subtests section already notes that the two await
their children differently. Nothing explains how they otherwise differ.
This adds a short "Suites versus subtests" section that shows the two
equivalent forms together and lists the differences: the context object
each callback receives, how their children are awaited, and what each
returns.
Fixes: #60758