Skip to content

doc(test): add missing passed and error on TextContext - #59322

Closed
SimonSchick wants to merge 5 commits into
nodejs:mainfrom
SimonSchick:docs/missing-test-context-properties
Closed

doc(test): add missing passed and error on TextContext#59322
SimonSchick wants to merge 5 commits into
nodejs:mainfrom
SimonSchick:docs/missing-test-context-properties

Conversation

@SimonSchick

Copy link
Copy Markdown
Contributor

See #59321 and #51485 for implementation

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/test_runner

@nodejs-github-botnodejs-github-bot added doc Issues and PRs related to the documentations. test_runner Issues and PRs related to the test runner subsystem. labels Aug 1, 2025
@SimonSchickSimonSchick changed the title docs(test): add missing docs for passed and error properties on TextContextdocs(test): add missing passed and error on TextContextAug 1, 2025
@SimonSchickSimonSchick changed the title docs(test): add missing passed and error on TextContextdoc(test): add missing passed and error on TextContextAug 1, 2025
@SimonSchick
SimonSchickforce-pushed the docs/missing-test-context-properties branch from 485f8ca to 24c4abcCompareAugust 1, 2025 21:34
@SimonSchick
SimonSchickforce-pushed the docs/missing-test-context-properties branch from 24c4abc to 7ddb4dcCompareAugust 1, 2025 21:36

@JakobJingleheimerJakobJingleheimer left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for raising.

I wasn't aware of this functionality; I'll check the implementation this weekend to confirm.

Comment threaddoc/api/test.md Outdated
Comment threaddoc/api/test.md Outdated
Comment threaddoc/api/test.md Outdated
Comment threaddoc/api/test.md Outdated
Co-authored-by: Jacob Smith <3012099+JakobJingleheimer@users.noreply.github.com>

@JakobJingleheimerJakobJingleheimer left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🙌

@JakobJingleheimerJakobJingleheimer added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. labels Aug 11, 2025
Comment threaddoc/api/test.md
### `context.passed` {boolean}

<!-- YAML
added: v20.12.0

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

According to the PR you linked

Suggested change
added: v20.12.0
added:
- v21.7.0
- v20.12.0

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@aduh95 should we land it as is and have a follow-up PR? This seems to already improve the situation over what we have right now.

Comment threaddoc/api/test.md
### `context.error` {Error|null}

<!-- YAML
added: v20.12.0

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here I reckon

Suggested change
added: v20.12.0
added:
- v21.7.0
- v20.12.0

Comment threaddoc/api/test.md
added: v20.12.0
-->

The failure reason for the test/case; if anything other than an instance of `Error` was thrown, that will be wrapped

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit

Suggested change
The failure reason for the test/case; if anything other than an instance of `Error` was thrown, that will be wrapped
The failure reason for the test/case; if anything other than an instance of {Error} was thrown, that will be wrapped

Xstoudi added a commit to Xstoudi/node that referenced this pull request Dec 28, 2025
`passed` and `error` properties were left undocumented on `TextContext`
class
Fixes: nodejs#59321
Refs: nodejs#51485
Refs: nodejs#59322
Co-authored-by: SimonSchick <demwizzy@gmail.com>
nodejs-github-bot pushed a commit that referenced this pull request Dec 30, 2025
`passed` and `error` properties were left undocumented on `TextContext`
class
Fixes: #59321
Refs: #51485
Refs: #59322
Co-authored-by: SimonSchick <demwizzy@gmail.com>
PR-URL: #61185
Reviewed-By: Aviv Keller <me@aviv.sh>
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
aduh95 pushed a commit that referenced this pull request Jan 9, 2026
`passed` and `error` properties were left undocumented on `TextContext`
class
Fixes: #59321
Refs: #51485
Refs: #59322
Co-authored-by: SimonSchick <demwizzy@gmail.com>
PR-URL: #61185
Reviewed-By: Aviv Keller <me@aviv.sh>
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
aduh95 pushed a commit that referenced this pull request Jan 12, 2026
`passed` and `error` properties were left undocumented on `TextContext`
class
Fixes: #59321
Refs: #51485
Refs: #59322
Co-authored-by: SimonSchick <demwizzy@gmail.com>
PR-URL: #61185
Reviewed-By: Aviv Keller <me@aviv.sh>
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
RafaelGSS pushed a commit that referenced this pull request Jan 13, 2026
`passed` and `error` properties were left undocumented on `TextContext`
class
Fixes: #59321
Refs: #51485
Refs: #59322
Co-authored-by: SimonSchick <demwizzy@gmail.com>
PR-URL: #61185
Reviewed-By: Aviv Keller <me@aviv.sh>
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
aduh95 pushed a commit that referenced this pull request Jan 19, 2026
`passed` and `error` properties were left undocumented on `TextContext`
class
Fixes: #59321
Refs: #51485
Refs: #59322
Co-authored-by: SimonSchick <demwizzy@gmail.com>
PR-URL: #61185
Reviewed-By: Aviv Keller <me@aviv.sh>
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
aduh95 pushed a commit that referenced this pull request Feb 17, 2026
`passed` and `error` properties were left undocumented on `TextContext`
class
Fixes: #59321
Refs: #51485
Refs: #59322
Co-authored-by: SimonSchick <demwizzy@gmail.com>
PR-URL: #61185
Reviewed-By: Aviv Keller <me@aviv.sh>
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
aduh95 pushed a commit that referenced this pull request Feb 19, 2026
`passed` and `error` properties were left undocumented on `TextContext`
class
Fixes: #59321
Refs: #51485
Refs: #59322
Co-authored-by: SimonSchick <demwizzy@gmail.com>
PR-URL: #61185
Reviewed-By: Aviv Keller <me@aviv.sh>
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
aduh95 pushed a commit that referenced this pull request Feb 21, 2026
`passed` and `error` properties were left undocumented on `TextContext`
class
Fixes: #59321
Refs: #51485
Refs: #59322
Co-authored-by: SimonSchick <demwizzy@gmail.com>
PR-URL: #61185
Reviewed-By: Aviv Keller <me@aviv.sh>
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
aduh95 pushed a commit that referenced this pull request Feb 23, 2026
`passed` and `error` properties were left undocumented on `TextContext`
class
Fixes: #59321
Refs: #51485
Refs: #59322
Co-authored-by: SimonSchick <demwizzy@gmail.com>
PR-URL: #61185
Reviewed-By: Aviv Keller <me@aviv.sh>
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.commit-queue-squashAdd this label to instruct the Commit Queue to squash all the PR commits into the first one.docIssues and PRs related to the documentations.test_runnerIssues and PRs related to the test runner subsystem.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@SimonSchick@nodejs-github-bot@JakobJingleheimer@MoLow@BridgeAR@aduh95