Skip to content

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

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

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

Conversation

@SimonSchick
Copy link
Contributor

@SimonSchick SimonSchick commented Aug 1, 2025

See #59321 and #51485 for implementation

@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented Aug 1, 2025

Review requested:

  • @nodejs/test_runner

@nodejs-github-bot nodejs-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
@SimonSchick SimonSchick changed the title docs(test): add missing docs for passed and error properties on TextContext docs(test): add missing passed and error on TextContext Aug 1, 2025
@SimonSchick SimonSchick changed the title docs(test): add missing passed and error on TextContext doc(test): add missing passed and error on TextContext Aug 1, 2025
@SimonSchick SimonSchick force-pushed the docs/missing-test-context-properties branch from 485f8ca to 24c4abc Compare August 1, 2025 21:34
@SimonSchick SimonSchick force-pushed the docs/missing-test-context-properties branch from 24c4abc to 7ddb4dc Compare August 1, 2025 21:36
JakobJingleheimer
JakobJingleheimer reviewed Aug 1, 2025
View reviewed changes
Copy link
Member

@JakobJingleheimer JakobJingleheimer left a comment

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.

JakobJingleheimer
JakobJingleheimer reviewed Aug 3, 2025
View reviewed changes
JakobJingleheimer
JakobJingleheimer reviewed Aug 10, 2025
View reviewed changes
@SimonSchick @JakobJingleheimer
Update doc/api/test.md
82ec081 
Co-authored-by: Jacob Smith <3012099+JakobJingleheimer@users.noreply.github.com>
JakobJingleheimer
JakobJingleheimer approved these changes Aug 11, 2025
View reviewed changes
Copy link
Member

@JakobJingleheimer JakobJingleheimer left a comment

Choose a reason for hiding this comment

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

🙌

@JakobJingleheimer JakobJingleheimer 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
@SimonSchick SimonSchick mentioned this pull request Aug 12, 2025
Closed
8 tasks
aduh95
aduh95 reviewed Aug 27, 2025
View reviewed changes
doc/api/test.md
### `context.passed` {boolean}

<!-- YAML
added: v20.12.0
Copy link
Contributor

@aduh95 aduh95 Aug 27, 2025

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
Member

@BridgeAR BridgeAR Sep 14, 2025

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.

aduh95
aduh95 reviewed Aug 27, 2025
View reviewed changes
doc/api/test.md
### `context.error` {Error|null}

<!-- YAML
added: v20.12.0
Copy link
Contributor

@aduh95 aduh95 Aug 27, 2025

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

aduh95
aduh95 reviewed Aug 27, 2025
View reviewed changes
doc/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
Contributor

@aduh95 aduh95 Aug 27, 2025

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

@SimonSchick SimonSchick closed this Dec 2, 2025
Xstoudi added a commit to Xstoudi/node that referenced this pull request Dec 28, 2025
@Xstoudi
doc: add missing passed and error properties on TestContext
d465ac6 
`passed` and `error` properties were left undocumented on `TextContext`
class

Fixes: nodejs#59321
Refs: nodejs#51485
Refs: nodejs#59322
@Xstoudi Xstoudi mentioned this pull request Dec 28, 2025
Merged
Xstoudi added a commit to Xstoudi/node that referenced this pull request Dec 28, 2025
@Xstoudi
doc: add missing passed and error properties on TestContext
a97071e 
`passed` and `error` properties were left undocumented on `TextContext`
class

Fixes: nodejs#59321
Refs: nodejs#51485
Refs: nodejs#59322
Xstoudi added a commit to Xstoudi/node that referenced this pull request Dec 28, 2025
@Xstoudi
doc: missing passed, error and passed properties on TestContext
59da2ba 
`passed` and `error` properties were left undocumented on `TextContext`
class

Fixes: nodejs#59321
Refs: nodejs#51485
Refs: nodejs#59322
Xstoudi added a commit to Xstoudi/node that referenced this pull request Dec 28, 2025
@Xstoudi @SimonSchick
doc: missing passed, error and passed properties on TestContext
addfc94 
`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
@Xstoudi @SimonSchick
doc: missing passed, error and passed properties on TestContext
20bf328 
`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
@Xstoudi @SimonSchick @aduh95
doc: missing passed, error and passed properties on TestContext
2ea1794 
`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
@Xstoudi @SimonSchick @aduh95
doc: missing passed, error and passed properties on TestContext
ab36966 
`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
@Xstoudi @SimonSchick @RafaelGSS
doc: missing passed, error and passed properties on TestContext
72f42b9 
`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
@Xstoudi @SimonSchick @aduh95
doc: missing passed, error and passed properties on TestContext
816ce75 
`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>
islandryu pushed a commit to islandryu/node that referenced this pull request Jan 25, 2026
@Xstoudi @SimonSchick @islandryu
doc: missing passed, error and passed properties on TestContext
721c3cf 
`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>
PR-URL: nodejs#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 free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@BridgeAR BridgeAR BridgeAR left review comments

@aduh95 aduh95 aduh95 left review comments

@JakobJingleheimer JakobJingleheimer JakobJingleheimer approved these changes

@MoLow MoLow MoLow approved these changes

Assignees

No one assigned

Labels

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. doc Issues and PRs related to the documentations. test_runner Issues and PRs related to the test runner subsystem.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

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