doc: several minor documentation improvements #23359

ChALkeR · 2018-10-10T00:12:41Z

This is a series of 4 loosely related documentation fixes.

doc: wrap links in <> — fixes links that were broken due to inclusion of the trailing dot (note how the doc has it incorrect now), simplifies a pair of occurances of []().
doc: fix pr-url in repl.md — Now it points to the actual pr, not to /compare/, that was invalid.
doc: use reserved domains for examples in url.md — changes non-reserved domains to reserved ones in url.md, per ref.
doc: fix url example to match behavior — fixes url: WHATWG API .origin behavior does not match the documentation #22653.

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
documentation is changed or added
commit message follows commit guidelines

nodejs-github-bot · 2018-10-10T00:12:42Z

@ChALkeR build started: https://ci.nodejs.org/blue/organizations/jenkins/node-test-pull-request-lite-pipeline/detail/node-test-pull-request-lite-pipeline/1185/pipeline

This fixes links that were broken due to inclusion of the trailing dot. Also simplifies a pair of occurances of []().

Now it points to the actual pr, not to /compare/.

Changes non-reserved domains to reserved ones in url.md. Refs: https://www.iana.org/domains/reserved

Fixes one WHATWG URL example to match the actual behavior. Fixes: nodejs#22653

Trott · 2018-10-10T01:20:33Z

Lite CI: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/1187/

danbev · 2018-10-15T03:58:24Z

Landed in 8d29569, 4ba1ddb, 0311fcc, and 3b1baf6.

This fixes links that were broken due to inclusion of the trailing dot. Also simplifies a pair of occurances of [](). PR-URL: #23359 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: James M Snell <[email protected]>

Now it points to the actual pr, not to /compare/. PR-URL: #23359 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: James M Snell <[email protected]>

Changes non-reserved domains to reserved ones in url.md. PR-URL: #23359 Refs: https://www.iana.org/domains/reserved Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: James M Snell <[email protected]>

Fixes one WHATWG URL example to match the actual behavior. PR-URL: #23359 Fixes: #22653 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: James M Snell <[email protected]>

This fixes links that were broken due to inclusion of the trailing dot. Also simplifies a pair of occurances of [](). PR-URL: #23359 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: James M Snell <[email protected]>

Now it points to the actual pr, not to /compare/. PR-URL: #23359 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: James M Snell <[email protected]>

Changes non-reserved domains to reserved ones in url.md. PR-URL: #23359 Refs: https://www.iana.org/domains/reserved Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: James M Snell <[email protected]>

Fixes one WHATWG URL example to match the actual behavior. PR-URL: #23359 Fixes: #22653 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: James M Snell <[email protected]>

This fixes links that were broken due to inclusion of the trailing dot. Also simplifies a pair of occurances of [](). PR-URL: #23359 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: James M Snell <[email protected]>

Now it points to the actual pr, not to /compare/. PR-URL: #23359 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: James M Snell <[email protected]>

Changes non-reserved domains to reserved ones in url.md. PR-URL: #23359 Refs: https://www.iana.org/domains/reserved Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: James M Snell <[email protected]>

Fixes one WHATWG URL example to match the actual behavior. PR-URL: #23359 Fixes: #22653 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: James M Snell <[email protected]>

This fixes links that were broken due to inclusion of the trailing dot. Also simplifies a pair of occurances of [](). PR-URL: #23359 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: James M Snell <[email protected]>

Now it points to the actual pr, not to /compare/. PR-URL: #23359 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: James M Snell <[email protected]>

Changes non-reserved domains to reserved ones in url.md. PR-URL: #23359 Refs: https://www.iana.org/domains/reserved Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: James M Snell <[email protected]>

Fixes one WHATWG URL example to match the actual behavior. PR-URL: #23359 Fixes: #22653 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: James M Snell <[email protected]>

This fixes links that were broken due to inclusion of the trailing dot. Also simplifies a pair of occurances of [](). PR-URL: #23359 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: James M Snell <[email protected]>

Now it points to the actual pr, not to /compare/. PR-URL: #23359 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: James M Snell <[email protected]>

Changes non-reserved domains to reserved ones in url.md. PR-URL: #23359 Refs: https://www.iana.org/domains/reserved Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: James M Snell <[email protected]>

Fixes one WHATWG URL example to match the actual behavior. PR-URL: #23359 Fixes: #22653 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: James M Snell <[email protected]>

This fixes links that were broken due to inclusion of the trailing dot. Also simplifies a pair of occurances of [](). PR-URL: #23359 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: James M Snell <[email protected]>

Now it points to the actual pr, not to /compare/. PR-URL: #23359 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: James M Snell <[email protected]>

Changes non-reserved domains to reserved ones in url.md. PR-URL: #23359 Refs: https://www.iana.org/domains/reserved Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: James M Snell <[email protected]>

Fixes one WHATWG URL example to match the actual behavior. PR-URL: #23359 Fixes: #22653 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: James M Snell <[email protected]>

ChALkeR requested review from Trott and TimothyGu October 10, 2018 00:12

nodejs-github-bot added the doc Issues and PRs related to the documentations. label Oct 10, 2018

ChALkeR added 4 commits October 10, 2018 03:18

doc: wrap links in <>

80e267a

This fixes links that were broken due to inclusion of the trailing dot. Also simplifies a pair of occurances of []().

doc: fix pr-url in repl.md

7ac0f2a

Now it points to the actual pr, not to /compare/.

doc: use reserved domains for examples in url.md

3f4dc54

Changes non-reserved domains to reserved ones in url.md. Refs: https://www.iana.org/domains/reserved

doc: fix url example to match behavior

a2af3a4

Fixes one WHATWG URL example to match the actual behavior. Fixes: nodejs#22653

ChALkeR force-pushed the fix-links branch from cdf3ff4 to a2af3a4 Compare October 10, 2018 00:21

Trott approved these changes Oct 10, 2018

View reviewed changes

thefourtheye approved these changes Oct 10, 2018

View reviewed changes

cjihrig approved these changes Oct 10, 2018

View reviewed changes

vsemozhetbyt approved these changes Oct 10, 2018

View reviewed changes

ChALkeR mentioned this pull request Oct 12, 2018

url: WHATWG API .origin behavior does not match the documentation #22653

Closed

TimothyGu approved these changes Oct 12, 2018

View reviewed changes

jasnell approved these changes Oct 12, 2018

View reviewed changes

danbev closed this Oct 15, 2018

codebytere mentioned this pull request Nov 27, 2018

v10.13.1 proposal #24675

Closed

codebytere mentioned this pull request Nov 29, 2018

v10.14.2 proposal #24727

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: several minor documentation improvements #23359

doc: several minor documentation improvements #23359

ChALkeR commented Oct 10, 2018 •

edited

Loading

nodejs-github-bot commented Oct 10, 2018

Trott commented Oct 10, 2018

danbev commented Oct 15, 2018

doc: several minor documentation improvements #23359

doc: several minor documentation improvements #23359

Conversation

ChALkeR commented Oct 10, 2018 • edited Loading

Checklist

nodejs-github-bot commented Oct 10, 2018

Trott commented Oct 10, 2018

danbev commented Oct 15, 2018

ChALkeR commented Oct 10, 2018 •

edited

Loading