doc: document directories in test directory #5557
Conversation
|
There are 2 directories that i am struggling to document: |
|
|
||
| ###parallel | ||
|
|
||
| Various tests that are run in parallel. |
There was a problem hiding this comment.
Nit: are run in parallel -> may be run in parallel.
There was a problem hiding this comment.
able to be run in parallel ;)
mscdex
added
doc
|
|
||
| | Runs on CI | | ||
| |:------------:| | ||
| | No | |
There was a problem hiding this comment.
This should be true I think.
There was a problem hiding this comment.
Yeah, it's run as part of make. If git blame isn't misleading me, @bnoordhuis wrote the one file in that directory and may be able to supply a half-sentence summary of what it does if no one else steps up. If all else fails, you can just say something hand-waving like "C++ test that is run as part of the build process".
|
|
|
Overall, looks like a fine start to me. Thanks for doing this. Hopefully we can fill in the one or two gaps and land this. |
|
@Trott Thanks for the feedback, i've updated the PR to include descriptions for |
|
|
||
| ###internet | ||
|
|
||
| Tests for networking related modules ([DNS](https://nodejs.org/api/dns.html), [HTTP](https://nodejs.org/api/http.html), [Net](https://nodejs.org/api/net.html), [TLS](https://nodejs.org/api/tls.html)). |
There was a problem hiding this comment.
Maybe give more details about how these actually make outbound connections. There are tests for all of those modules in both /parallel and /sequential. None of those actually go outside the local network though.
There was a problem hiding this comment.
nit: long line. Please keep them under 80 columns
|
LGTM with the few nits fixed. Thanks! |
|
|
||
| | Runs on CI | | ||
| |:----------:| | ||
| | No | |
There was a problem hiding this comment.
Maybe an explanation of why those tests are not run in CI could be useful?
There was a problem hiding this comment.
I agree that would be useful.
|
#5528 added a |
|
Fixed the long line issues, updated the description for the |
|
LGTM. (There are gaps that experienced people might be able to fill in. But as this is, it is much better than what we have now, which is nothing.) |
| |:----------:| | ||
| | No | | ||
|
|
||
| ###addons |
There was a problem hiding this comment.
Please add a space after the hashes. Various markdown parsers fail to render such headings otherwise.
|
LGTM |
|
I know we usually don't run CI on doc-only changes, but I have this nagging sense that there's a non-zero possibility that an extra file in |
|
LGTM |
PR-URL: nodejs#5557 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
|
Landed in 96af474 |
PR-URL: #5557 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
PR-URL: #5557 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
PR-URL: #5557 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
PR-URL: #5557 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
PR-URL: #5557 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
Pull Request check-list
Please make sure to review and check all of these items:
make -j8 test(UNIX) orvcbuild test nosign(Windows) pass withthis change (including linting)?
test (or a benchmark) included?
existing APIs, or introduces new ones)?
NOTE: these things are not required to open a PR and can be done
afterwards / while the PR is open.
Affected core subsystem(s)
Description of change
Add documentation for test directory as per #5538