Skip to content

doc: add comma and colon in message with --inspector doc url - #19871

Closed
n-filatov wants to merge 2 commits into
nodejs:masterfrom
n-filatov:master
Closed

doc: add comma and colon in message with --inspector doc url#19871
n-filatov wants to merge 2 commits into
nodejs:masterfrom
n-filatov:master

Conversation

@n-filatov

@n-filatovn-filatov commented Apr 7, 2018

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

When i follow link https://nodejs.org/en/docs/inspector i get 404 error. Replaced on https://nodejs.org/en/docs/guides/debugging-getting-started/ with inspect flag documentation

@nodejs-github-botnodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. dont-land-on-v4.x inspector Issues and PRs related to the V8 inspector protocol. labels Apr 7, 2018
cjihrig
cjihrig approved these changes Apr 7, 2018
View reviewed changes

@cjihrigcjihrig left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can you drop the trailing slash from the URL? Otherwise, LGTM.

@n-filatov

n-filatov commented Apr 7, 2018

Copy link
Copy Markdown
ContributorAuthor

@cjihrig Done

@richardlau

richardlau commented Apr 7, 2018

Copy link
Copy Markdown
Member

cc @nodejs/diagnostics

@richardlau

richardlau commented Apr 7, 2018

Copy link
Copy Markdown
Member

https://nodejs.org/en/docs/inspector/ redirects to https://nodejs.org/en/docs/guides/debugging-getting-started/ but https://nodejs.org/en/docs/inspector (without the trailing slash) 404's.

@cjihrig

cjihrig commented Apr 7, 2018•
edited
Loading

Copy link
Copy Markdown
Contributor

Good catch @richardlau. We should keep the existingURL and add the trailing slash, although I think a better solution is for the website to not require the trailing slash.

@n-filatov

n-filatov commented Apr 7, 2018

Copy link
Copy Markdown
ContributorAuthor

Returned old URL but with trailing slash. Also created issue in nodejs.org repo to fix this bug.

@Trott

Trott commented Apr 8, 2018

Copy link
Copy Markdown
Member

Super minor nits, but while we're in here, can we add a comma after help and a period at the end in all of these? For help, see <URL>. If the period is undesirable, use a colon after see instead: For help, see: <URL>

@Trott

Trott commented Apr 8, 2018

Copy link
Copy Markdown
Member

(Also: Hi, @Muffassa! Welcome and thanks for the PR! These kinds of changes often attract lots of comments. Don't get discouraged! And thanks again!)

@n-filatov

n-filatov commented Apr 8, 2018

Copy link
Copy Markdown
ContributorAuthor

@Trott No problem :) Fixed

@Trott

Trott commented Apr 8, 2018

Copy link
Copy Markdown
Member

CI: https://ci.nodejs.org/job/node-test-pull-request/14125/

@TrottTrott added the author ready PRs with CI started, the required approvals, and no outstanding review comments. label Apr 8, 2018
@BridgeARBridgeAR added the fast-track PRs proposed for a shorter-than-standard waiting period before landing. label Apr 8, 2018
@cjihrigcjihrig mentioned this pull request Apr 9, 2018
Merged
3 tasks
@richardlau

richardlau commented Apr 9, 2018

Copy link
Copy Markdown
Member

nodejs/build#1219 has fixed the redirect for the original URL.

@Trott

Trott commented Apr 9, 2018

Copy link
Copy Markdown
Member

nodejs/build#1219 has fixed the redirect for the original URL.

Would that make this PR unnecessary and close-able? (It seems that way to me, with apologies to @Muffassa for giving them nits/comments and then ultimately not accepting the change, but it happens.)

@Trott

Trott commented Apr 9, 2018

Copy link
Copy Markdown
Member

Oh, actually, those commas are still an improvement, so this could land, probably preferably with the slashes omitted though?

@Trott

Trott commented Apr 9, 2018

Copy link
Copy Markdown
Member

(Commit message will probably need to be updated too.)

@n-filatovn-filatov changed the title src: replace inspect flag documentation linkdoc: add comma and colon in message with --inspector doc urlApr 9, 2018
@n-filatov

n-filatov commented Apr 9, 2018

Copy link
Copy Markdown
ContributorAuthor

Changed commit messages, removed slash in the end of url, changed request message.

@BridgeAR

BridgeAR commented Apr 9, 2018

Copy link
Copy Markdown
Member

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

@BridgeAR

BridgeAR commented Apr 9, 2018

Copy link
Copy Markdown
Member

Landed in f3e107a.

@Muffassa congratulations on your first commit to Node.js and to officially becoming a contributor! 🎉

@BridgeARBridgeAR closed this Apr 9, 2018
BridgeAR pushed a commit to BridgeAR/node that referenced this pull request Apr 9, 2018
@n-filatov@BridgeAR
src: add punctuation in --inspector doc url message
f3e107a
PR-URL: nodejs#19871
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Ali Ijaz Sheikh <ofrobots@google.com>
cjihrig added a commit to cjihrig/node that referenced this pull request Apr 10, 2018
@cjihrig
test: verify inspector help url works
dfea13a
This commit adds basic functionality testing of the
help URL printed when the inspector starts.
PR-URL: nodejs#19887
Refs: nodejs#19871
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit that referenced this pull request Apr 12, 2018
@n-filatov@targos
src: add punctuation in --inspector doc url message
95ab327
PR-URL: #19871
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Ali Ijaz Sheikh <ofrobots@google.com>
targos pushed a commit that referenced this pull request Apr 12, 2018
@cjihrig@targos
test: verify inspector help url works
2ef3380
This commit adds basic functionality testing of the
help URL printed when the inspector starts.
PR-URL: #19887
Refs: #19871
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@TrottTrottTrott approved these changes
@cjihrigcjihrigcjihrig approved these changes
@richardlaurichardlaurichardlau approved these changes
@BridgeARBridgeARBridgeAR approved these changes
@trivikrtrivikrtrivikr approved these changes
+3 more reviewers
@ofrobotsofrobotsofrobots approved these changes
@TimothyGuTimothyGuTimothyGu approved these changes
@marswongmarswongmarswong approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

author readyPRs with CI started, the required approvals, and no outstanding review comments.c++Issues and PRs that require attention from people who are familiar with C++.fast-trackPRs proposed for a shorter-than-standard waiting period before landing.inspectorIssues and PRs related to the V8 inspector protocol.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

10 participants

@n-filatov@richardlau@cjihrig@Trott@BridgeAR@ofrobots@TimothyGu@marswong@trivikr@nodejs-github-bot