Skip to content

Commit 14b3ba3

Browse files
Trottrvagg
authored andcommitted
doc: improve debugger doc prose
PR-URL: #7007 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent 3c2c4c8 commit 14b3ba3

File tree

1 file changed

+7
-10
lines changed

1 file changed

+7
-10
lines changed

doc/api/debugger.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,11 @@ break in /home/indutny/Code/git/indutny/myscript.js:1
2020
debug>
2121
```
2222

23-
Node.js's debugger client does not yet support the full range of commands, but
24-
simple step and inspection are possible.
23+
Node.js's debugger client is not a full-featured debugger, but simple step and
24+
inspection are possible.
2525

2626
Inserting the statement `debugger;` into the source code of a script will
27-
enable a breakpoint at that position in the code.
28-
29-
For example, suppose `myscript.js` is written as:
27+
enable a breakpoint at that position in the code:
3028

3129
```js
3230
// myscript.js
@@ -81,8 +79,7 @@ debug> quit
8179
```
8280

8381
The `repl` command allows code to be evaluated remotely. The `next` command
84-
steps over to the next line. Type `help` to see what other commands are
85-
available.
82+
steps to the next line. Type `help` to see what other commands are available.
8683

8784
Pressing `enter` without typing a command will repeat the previous debugger
8885
command.
@@ -98,7 +95,7 @@ To begin watching an expression, type `watch('my_expression')`. The command
9895
`watchers` will print the active watchers. To remove a watcher, type
9996
`unwatch('my_expression')`.
10097

101-
## Commands reference
98+
## Command reference
10299

103100
### Stepping
104101

@@ -145,7 +142,7 @@ break in test/fixtures/break-in-module/mod.js:23
145142
debug>
146143
```
147144

148-
### Info
145+
### Information
149146

150147
* `backtrace`, `bt` - Print backtrace of current execution frame
151148
* `list(5)` - List scripts source code with 5 line context (5 lines before and
@@ -174,7 +171,7 @@ An alternative way of enabling and accessing the debugger is to start
174171
Node.js with the `--debug` command-line flag or by signaling an existing
175172
Node.js process with `SIGUSR1`.
176173

177-
Once a process has been set in debug mode this way, it can be connected to
174+
Once a process has been set in debug mode this way, it can be inspected
178175
using the Node.js debugger by either connecting to the `pid` of the running
179176
process or via URI reference to the listening debugger:
180177

0 commit comments

Comments
 (0)