-
-
Notifications
You must be signed in to change notification settings - Fork 33.8k
doc: add fullName property to SuiteContext #60762
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
doc: add fullName property to SuiteContext #60762
Conversation
Add documentation for the missing fullName property in SuiteContext class. This property returns the name of the suite and each of its ancestors, separated by '>'. The property has been available since v22.3.0 but was missing from the documentation. Fixes: nodejs#60757
|
Review requested:
|
Ethan-Arrowood
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm just not sure about the version number otherwise lgtm
| ### `context.fullName` | ||
|
|
||
| <!-- YAML | ||
| added: v22.3.0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The docblock for TestContext#fullName (same commit as this one, presumably that's what this PR is mirroring) didn't get REPLACEME'd when merged to v20.x, for whatever reason. Both could be amended to add the v20.x version to the list, but it should be kept consistent either way.
Renegade334
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM but please address the commit linter error.
The fullName property exists on SuiteContext at runtime but was not documented.
Tested to verify behavior:
Fixes: #60757