doc: add common.WPT to test README #11127

Closed
wants to merge 1 commit into
from

Conversation

@Trott
Member

Trott commented Feb 2, 2017

Checklist
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc test

@Trott Trott added doc test labels Feb 2, 2017

@Trott Trott requested a review from joyeecheung Feb 2, 2017

@Trott

This comment has been minimized.

Show comment
Hide comment
@Trott

Trott Feb 2, 2017

Member

(This documentation is a stub.)

Member

Trott commented Feb 2, 2017

(This documentation is a stub.)

@Trott Trott referenced this pull request Feb 2, 2017

Closed

test: simplify WPT.assert_throws() #11126

2 of 2 tasks complete
@TimothyGu

Other than the nit, LGTM.

test/README.md
+### WPT
+
+An implementation of parts of the W3C Web Platform Test harness. It is used in
+to test WHATWG URL conformance.

This comment has been minimized.

@TimothyGu

TimothyGu Feb 2, 2017

Member

A link would be helpful (Web Platform Tests and/or testharness.js). Also the second sentence seems to have an extra "in".

@TimothyGu

TimothyGu Feb 2, 2017

Member

A link would be helpful (Web Platform Tests and/or testharness.js). Also the second sentence seems to have an extra "in".

@TimothyGu

This comment has been minimized.

Show comment
Hide comment
@TimothyGu

TimothyGu Feb 2, 2017

Member

I personally don't really think it's necessary to extend this documentation stub, when WPT's APIs are documented elsewhere anyway.

Member

TimothyGu commented Feb 2, 2017

I personally don't really think it's necessary to extend this documentation stub, when WPT's APIs are documented elsewhere anyway.

@Trott

This comment has been minimized.

Show comment
Hide comment
@Trott

Trott Feb 2, 2017

Member

@TimothyGu Thanks. I incorporated both links and got a little more specific with the text. PTAL.

Member

Trott commented Feb 2, 2017

@TimothyGu Thanks. I incorporated both links and got a little more specific with the text. PTAL.

@TimothyGu

LGTM. Thanks for writing this.

test/README.md
+
+### WPT
+
+An implementation of parts of

This comment has been minimized.

@joyeecheung

joyeecheung Feb 2, 2017

Member

I would say it's more like a "mock" or "port"? But this description LGTM too.

@joyeecheung

joyeecheung Feb 2, 2017

Member

I would say it's more like a "mock" or "port"? But this description LGTM too.

This comment has been minimized.

@Trott

Trott Feb 2, 2017

Member

"port" works for me. I'll change it.

@Trott

Trott Feb 2, 2017

Member

"port" works for me. I'll change it.

@mhdawson

LGTM

@jasnell

jasnell approved these changes Feb 2, 2017

@@ -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

This comment has been minimized.

@gibfahn

gibfahn Feb 2, 2017

Member

Maybe ### WPT (Web Platform Tests) for people who don't know what it is and don't see the link two lines down?

@gibfahn

gibfahn Feb 2, 2017

Member

Maybe ### WPT (Web Platform Tests) for people who don't know what it is and don't see the link two lines down?

This comment has been minimized.

@Trott

Trott Feb 2, 2017

Member

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.

@Trott

Trott Feb 2, 2017

Member

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.

This comment has been minimized.

@gibfahn

gibfahn Feb 3, 2017

Member

Maybe just start the next line with it, something like:

Web Platform Tests - A port of parts of
@gibfahn

gibfahn Feb 3, 2017

Member

Maybe just start the next line with it, something like:

Web Platform Tests - A port of parts of
test/README.md
+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)

This comment has been minimized.

This comment has been minimized.

@Trott

Trott Feb 5, 2017

Member

👍 Done.

@Trott

Trott Feb 5, 2017

Member

👍 Done.

Trott added a commit to Trott/io.js that referenced this pull request Feb 6, 2017

doc: add common.WPT to test README
PR-URL: nodejs#11127
Reviewed-By: Timothy Gu <timothygu99@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@Trott

This comment has been minimized.

Show comment
Hide comment
@Trott

Trott Feb 6, 2017

Member

Landed in 3fffebb

Member

Trott commented Feb 6, 2017

Landed in 3fffebb

@Trott Trott closed this Feb 6, 2017

italoacasas added a commit that referenced this pull request Feb 6, 2017

doc: add common.WPT to test README
PR-URL: #11127
Reviewed-By: Timothy Gu <timothygu99@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>

italoacasas added a commit to italoacasas/node that referenced this pull request Feb 14, 2017

doc: add common.WPT to test README
PR-URL: nodejs#11127
Reviewed-By: Timothy Gu <timothygu99@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>

KryDos added a commit to KryDos/node that referenced this pull request Feb 25, 2017

doc: add common.WPT to test README
PR-URL: nodejs#11127
Reviewed-By: Timothy Gu <timothygu99@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment