doc: add example for running with v8-inspector #8845
Conversation
nodejs-github-bot
added
debugger
doc
mscdex
added
inspector
doc/api/debugger.md
Outdated
There was a problem hiding this comment.
nit: I guess “normal” users don’t call it with the ./? 😄
doc/api/debugger.md
Outdated
There was a problem hiding this comment.
Nit: I would just use node without ./. It's unlikely that there is a node executable in the folder where the command is run.
Edit: @addaleax won the race condition here 😄.
doc/api/debugger.md
Outdated
There was a problem hiding this comment.
Nit: maybe it's better to not split this line as it is a URL. I'm not sure though because if it isn't split scrolling is required on small screens.
There was a problem hiding this comment.
Changed, no line break in url.
fhinkel
force-pushed
the
docInspector
branch
from
072e6b1 to
467b753
Compare
|
@fhinkel while you are at it s/Add/add/ in the first line of commit message. |
Add example to show what running Node.js with `--inspect` should look like. Some IDEs do not show the link when running with `--inspect`. This example hints to what the full output looks like.
fhinkel
force-pushed
the
docInspector
branch
from
467b753 to
0c406a1
Compare
fhinkel
changed the title
cjihrig
left a comment
cjihrig
left a comment
There was a problem hiding this comment.
LGTM, but maybe this should go after the first paragraph of the V8 inspector section.
|
wasn't one of the reasons for not documenting it because it was an experimental feature? /cc @nodejs/ctc I'm not neccessarily opposed to this, but I do think we should be careful about the support story in experimental features |
|
It's already documented, and comes with a big bold warning that it's experimental. I don't think this PR adds any additional support commitment. |
|
I retract my original statement then. This example is a great thing to include LGTM |
|
LGTM |
Add example to show what running Node.js with `--inspect` should look like. Some IDEs do not show the link when running with `--inspect`. This example hints to what the full output looks like. PR-URL: #8845 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Myles Borins <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]>
|
Landed in bdb8012. Thank you! |
Add example to show what running Node.js with `--inspect` should look like. Some IDEs do not show the link when running with `--inspect`. This example hints to what the full output looks like. PR-URL: #8845 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Myles Borins <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]>
Add example to show what running Node.js with `--inspect` should look like. Some IDEs do not show the link when running with `--inspect`. This example hints to what the full output looks like. PR-URL: #8845 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Myles Borins <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]>
9 participants
Checklist
make -j8 test(UNIX) passesAffected core subsystem(s)
doc debugger
Description of change
Add example to show what running Node.js with
--inspectshould look like.
Some IDEs do not show the link when running with
--inspect.This example hints to what the full output looks like.