cli help documentation for --inspect

[nojvek]

Now that --inspect is in, there should be documentation in node -h about inspect, debug, debug-brk, debug-port params.

I volunteer to send this as my first node PR. I believe @Fishrock123 mentioned where I need to make this edits.

[MylesBorins]

@nojvek I'm not sure that there is currently consensus on if this should be documented or not yet... it is not yet considered a stable feature and as such documentation may give the wrong impression (for --inspect).

I'm not sure the best road forward regarding the current debugger.

/cc @nodejs/documentation

[nojvek]

I'm fine with whatever the node gods decide. I think debug, debug-brk and
debug-help should be in the cli help though. I should go ahead with that
right?

What's the criteria for something to be marked as stable?

On Monday, May 30, 2016, Myles Borins [email protected] wrote:

@nojvek https://github.com/nojvek I'm not sure that there is currently
consensus on if this should be documented or not yet... it is not yet
considered a stable feature and as such documentation may give the wrong
impression (for --inspect).

I'm not sure the best road forward regarding the current debugger.

/cc @nodejs/documentation
https://github.com/orgs/nodejs/teams/documentation

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#7065 (comment), or mute
the thread
https://github.com/notifications/unsubscribe/AA-JVEfpeTGQ8kDInop6ER6EY2on6e9eks5qGxlfgaJpZM4Ip6i3
.

[benjamingr]

I'm against documenting it at the moment. It's experimental support and we won't be able to properly support usages.

[nojvek]

Only adding --debug and --debug-brk. See #7086

/cc @nodejs/documentation

@Fishrock123, should this be still labeled blocked?

[Fishrock123]

A new issue should have been made, changing this back to be about --inspect. Just the pr for those is fine.

[nojvek]

I'm sorry I'm confused now. I thought the plan was not to have inspect in
node -h. Its usage is already documented in debugger.md

On Wednesday, June 1, 2016, Jeremiah Senkpiel [email protected]
wrote:

A new issue should have been made, changing this back to be about
--inspect. Just the pr for those is fine.

—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
#7065 (comment), or mute
the thread
https://github.com/notifications/unsubscribe/AA-JVIU0-CnBVT83cKvH2O7USD8eWRMXks5qHZV9gaJpZM4Ip6i3
.