Skip to content
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

Closed
wants to merge 1 commit into from
Closed

doc: add common.WPT to test README #11127

wants to merge 1 commit into from

Conversation

Trott
Copy link
Member

@Trott 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 Issues and PRs related to the documentations. test Issues and PRs related to the tests. labels Feb 2, 2017
@nodejs-github-bot nodejs-github-bot added the test Issues and PRs related to the tests. label Feb 2, 2017
@Trott
Copy link
Member Author

Trott commented Feb 2, 2017

(This documentation is a stub.)

@Trott Trott mentioned this pull request Feb 2, 2017
2 tasks
Copy link
Member

@TimothyGu TimothyGu left a 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.
Copy link
Member

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".

@TimothyGu
Copy link
Member

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

@Trott
Copy link
Member Author

Trott commented Feb 2, 2017

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

Copy link
Member

@TimothyGu TimothyGu left a 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
Copy link
Member

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.

Copy link
Member Author

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.

Copy link
Member

@mhdawson mhdawson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@@ -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
Copy link
Member

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?

Copy link
Member Author

@Trott Trott Feb 2, 2017

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.

Copy link
Member

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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Done.

Trott added a commit to Trott/io.js that referenced this pull request Feb 6, 2017
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]>
@Trott
Copy link
Member Author

Trott commented Feb 6, 2017

Landed in 3fffebb

@Trott Trott closed this Feb 6, 2017
italoacasas pushed a commit that referenced this pull request Feb 6, 2017
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]>
italoacasas pushed a commit to italoacasas/node that referenced this pull request Feb 14, 2017
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]>
krydos pushed a commit to krydos/node that referenced this pull request Feb 25, 2017
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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. test Issues and PRs related to the tests.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants