-
Notifications
You must be signed in to change notification settings - Fork 29.8k
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
doc: add common.WPT to test README #11127
Conversation
(This documentation is a stub.) |
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.
Other than the nit, LGTM.
test/README.md
Outdated
### WPT | ||
|
||
An implementation of parts of the W3C Web Platform Test harness. It is used in | ||
to test WHATWG URL conformance. |
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.
A link would be helpful (Web Platform Tests and/or testharness.js). Also the second sentence seems to have an extra "in".
I personally don't really think it's necessary to extend this documentation stub, when |
@TimothyGu Thanks. I incorporated both links and got a little more specific with the text. PTAL. |
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. Thanks for writing this.
test/README.md
Outdated
|
||
### WPT | ||
|
||
An implementation of parts of |
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 would say it's more like a "mock" or "port"? But this description LGTM too.
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.
"port" works for me. I'll change it.
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
d28ea8c
to
c284e24
Compare
@@ -379,3 +379,12 @@ The realpath of the 'tmp' directory. | |||
* return [<String>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type) | |||
|
|||
Name of the temp directory used by tests. | |||
|
|||
### WPT |
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.
Maybe ### WPT (Web Platform Tests)
for people who don't know what it is and don't see the link two lines down?
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.
Parentheses are used to show arguments in the other entries so I probably wouldn't do it exactly that way. But if there's a way to clarify it in the text below, I'm happy to.
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.
Maybe just start the next line with it, something like:
Web Platform Tests - A port of parts of
test/README.md
Outdated
A port of parts of | ||
[W3C testharness.js](https://github.com/w3c/testharness.js) for testing the | ||
Node.js | ||
[WHATWG URL API](https://github.com/nodejs/node/blob/master/doc/api/url.md#the-whatwg-url-api) |
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.
👍 Done.
PR-URL: nodejs#11127 Reviewed-By: Timothy Gu <[email protected]> Reviewed-By: Joyee Cheung <[email protected]> Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: James M Snell <[email protected]>
Landed in 3fffebb |
PR-URL: #11127 Reviewed-By: Timothy Gu <[email protected]> Reviewed-By: Joyee Cheung <[email protected]> Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: James M Snell <[email protected]>
PR-URL: nodejs#11127 Reviewed-By: Timothy Gu <[email protected]> Reviewed-By: Joyee Cheung <[email protected]> Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: James M Snell <[email protected]>
PR-URL: nodejs#11127 Reviewed-By: Timothy Gu <[email protected]> Reviewed-By: Joyee Cheung <[email protected]> Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: James M Snell <[email protected]>
Checklist
Affected core subsystem(s)
doc test