Skip to content

Commit b5ce120

Browse files
committed
update doc
1 parent 359747b commit b5ce120

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -536,7 +536,8 @@ There are additional features:
536536
* `<expr>` without debug command is almost same as `pp <expr>`.
537537
* If the input line `<expr>` does *NOT* start with any debug command, the line `<expr>` will be evaluated as a Ruby expression and the result will be printed with `pp` method. So that the input `foo.bar` is same as `pp foo.bar`.
538538
* If `<expr>` is recognized as a debug command, of course it is not evaluated as a Ruby expression, but is executed as debug command. For example, you can not evaluate such single letter local variables `i`, `b`, `n`, `c` because they are single letter debug commands. Use `p i` instead.
539-
* `Enter` without any input repeats the last command (useful when repeating `step`s).
539+
* So the author (Koichi Sasada) recommends to use `p`, `pp` or `eval` command to evaluate the Ruby expression everytime.
540+
* `Enter` without any input repeats the last command (useful when repeating `step`s) for some commands.
540541
* `Ctrl-D` is equal to `quit` command.
541542
* [debug command compare sheet - Google Sheets](https://docs.google.com/spreadsheets/d/1TlmmUDsvwK4sSIyoMv-io52BUUz__R5wpu-ComXlsw0/edit?usp=sharing)
542543

@@ -550,6 +551,8 @@ The `<...>` notation means the argument.
550551
* Step in. Resume the program until next breakable point.
551552
* `s[tep] <n>`
552553
* Step in, resume the program at `<n>`th breakable point.
554+
* `s[tep] into <name>` or `s[tep] into /regexp/`
555+
* Stop at the beggining of method `<name>` or the name matched to `/regexp/`
553556
* `n[ext]`
554557
* Step over. Resume the program until next line.
555558
* `n[ext] <n>`
@@ -904,8 +907,8 @@ NOTE
904907
905908
# Additional Resources
906909
907-
- [From byebug to ruby/debug](https://st0012.dev/from-byebug-to-ruby-debug) - A migration guide for `byebug` users.
908-
- [ruby/debug cheatsheet](https://st0012.dev/ruby-debug-cheatsheet)
910+
- [From byebug to ruby/debug](https://st0012.dev/from-byebug-to-ruby-debug) by Stan Lo - A migration guide for `byebug` users.
911+
- [ruby/debug cheatsheet](https://st0012.dev/ruby-debug-cheatsheet) by Stan Lo
909912
910913
# Contributing
911914

misc/README.md.erb

+4-3
Original file line numberDiff line numberDiff line change
@@ -498,7 +498,8 @@ There are additional features:
498498
* `<expr>` without debug command is almost same as `pp <expr>`.
499499
* If the input line `<expr>` does *NOT* start with any debug command, the line `<expr>` will be evaluated as a Ruby expression and the result will be printed with `pp` method. So that the input `foo.bar` is same as `pp foo.bar`.
500500
* If `<expr>` is recognized as a debug command, of course it is not evaluated as a Ruby expression, but is executed as debug command. For example, you can not evaluate such single letter local variables `i`, `b`, `n`, `c` because they are single letter debug commands. Use `p i` instead.
501-
* `Enter` without any input repeats the last command (useful when repeating `step`s).
501+
* So the author (Koichi Sasada) recommends to use `p`, `pp` or `eval` command to evaluate the Ruby expression everytime.
502+
* `Enter` without any input repeats the last command (useful when repeating `step`s) for some commands.
502503
* `Ctrl-D` is equal to `quit` command.
503504
* [debug command compare sheet - Google Sheets](https://docs.google.com/spreadsheets/d/1TlmmUDsvwK4sSIyoMv-io52BUUz__R5wpu-ComXlsw0/edit?usp=sharing)
504505

@@ -593,8 +594,8 @@ On this case, you can see the result of `bar()` every time you stop there.
593594

594595
# Additional Resources
595596

596-
- [From byebug to ruby/debug](https://st0012.dev/from-byebug-to-ruby-debug) - A migration guide for `byebug` users.
597-
- [ruby/debug cheatsheet](https://st0012.dev/ruby-debug-cheatsheet)
597+
- [From byebug to ruby/debug](https://st0012.dev/from-byebug-to-ruby-debug) by Stan Lo - A migration guide for `byebug` users.
598+
- [ruby/debug cheatsheet](https://st0012.dev/ruby-debug-cheatsheet) by Stan Lo
598599

599600
# Contributing
600601

0 commit comments

Comments
 (0)