doc: add missing function to test common doc #11382
Closed
Conversation
This file contains 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
Trott
added
doc
jasnell
approved these changes
Feb 14, 2017
gibfahn
approved these changes
Feb 15, 2017
targos
approved these changes
Feb 15, 2017
test/README.md
Outdated
| @@ -175,6 +175,13 @@ On non-Windows platforms, this currently returns true. | |||
|
|
|||
| Platform normalizes the `dd` command | |||
|
|
|||
| ### expectsError(code[, type[, message]]) | |||
There was a problem hiding this comment.
nit: I know the list is not completely in alphabetical order but can you move this below enoughTestMem?
There was a problem hiding this comment.
Oooh, yes, definitely, will do!
joyeecheung
reviewed
Feb 15, 2017
test/README.md
Outdated
| @@ -175,6 +175,13 @@ On non-Windows platforms, this currently returns true. | |||
|
|
|||
| Platform normalizes the `dd` command | |||
|
|
|||
| ### expectsError(code[, type[, message]]) | |||
| * `code` [<String>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type) expected error must have this value for its `code` property | |||
| * `type` [<constructor>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes/constructor) expected error must be an instance of `type` | |||
There was a problem hiding this comment.
constructor is not actually a type...I think this is a Function and should be noted that it needs to be one that's subclassed by the internal/errors module? (Maybe a link to the guide here)
There was a problem hiding this comment.
All good suggestions, implementing momentarily, thanks!
test/README.md
Outdated
| ### expectsError(code[, type[, message]]) | ||
| * `code` [<String>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type) expected error must have this value for its `code` property | ||
| * `type` [<constructor>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes/constructor) expected error must be an instance of `type` | ||
| * `message` [<String>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type) or [<RegExp>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp) if a string is provided for `message`, expected error must have it for its `message` property; if a regular expression is provided for `message`, the regular expression must match the `message` property of the expected error |
Add documentation for `common.expectsError()` to `test/README.md`.
joyeecheung
approved these changes
Feb 16, 2017
lpinca
approved these changes
Feb 16, 2017
jasnell
pushed a commit
that referenced
this pull request
Feb 16, 2017
Add documentation for `common.expectsError()` to `test/README.md`. PR-URL: #11382 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
|
Landed in b5c8852 |
italoacasas
pushed a commit
to italoacasas/node
that referenced
this pull request
Feb 20, 2017
Add documentation for `common.expectsError()` to `test/README.md`. PR-URL: nodejs#11382 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
italoacasas
pushed a commit
that referenced
this pull request
Feb 22, 2017
Add documentation for `common.expectsError()` to `test/README.md`. PR-URL: #11382 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Merged
|
Depends on the |
This was referenced Dec 10, 2023
This was referenced Dec 10, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add documentation for
common.expectsError()totest/README.md.Checklist
Affected core subsystem(s)
test doc