doc: fix example single-test command - #29171
Conversation
Sorry, something went wrong.
Changes example command to refer to the correct test directory: `./test/parallel/` instead of `./parallel/`
|
Some history: Originally the test runner specified tests to run by the name of the test suite (e.g. parallel) and optionally tests within it (e.g. parallel/test-fs-* to run all the tests in test/parallel beginning with test-fs-). Later on a change was made (#9694) to also allow specifying the path to the test file (e.g. test/parallel/test-stream2-transform.js). The result is that the runner is fairly lenient (e.g. you can omit the .js extensions if specifying a path) and the existing example will work. I'll defer to others as to whether the example should be changed (both the original and the change made in this PR will be accepted by the test runner). |
Sorry, something went wrong.
Sorry, something went wrong.
Trott
left a comment
There was a problem hiding this comment.
Because there's no explanation that you can leave off the test/ (and, for that matter, the .js), it's probably best to just use the full path like this. I would prefer if the commit message is amended when we land this to say "improve" (or something similar) rather than "fix" as this isn't actually broken, IMO.
Sorry, something went wrong.
|
Should we also document that parallel/test-* works or should we deprecate it? |
Sorry, something went wrong.
IMO, neither. |
Sorry, something went wrong.
A little more detail: No need to deprecate. End users never use/see this tool. It's for us. No need to document that you can leave off test/ and .js. It's not significant. If people know about it, cool. If they don't, it's not hurting them. So, just leave it in (for people who are using it and like it) but don't document it because it unnecessarily complicates the documentation. |
Sorry, something went wrong.
Changes example command to refer to the full test directory: `./test/parallel/` instead of `./parallel/` PR-URL: #29171 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
|
Landed in 287c3ab. Thanks for the contribution! 🎉 |
Sorry, something went wrong.
Changes example command to refer to the full test directory: `./test/parallel/` instead of `./parallel/` PR-URL: #29171 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Changes example command to refer to the correct test directory: ./test/parallel/ instead of ./parallel/
Checklist