Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Show commands as table #405

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 13 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,31 +45,21 @@ to use it to debug your tests!

### Step-by-step debugging

**break:** Manage breakpoints.

**step:** Step execution into the next line or method. Takes an optional numeric
argument to step multiple times.

**next:** Step over to the next line within the same frame. Also takes an
optional numeric argument to step multiple lines.

**finish:** Execute until current stack frame returns.

**continue:** Continue program execution and end the Pry session.
| **Command** | **Description** |
|-------------|-------------------------------------------------------------------------------------------------------------------|
| `break` | Manage breakpoints. |
| `step` | Step execution into the next line or method. Takes an optional numeric argument to step multiple times. |
| `next` | Step over to the next line within the same frame. Also takes an optional numeric argument to step multiple lines. |
| `finish` | Execute until current stack frame returns. |
| `continue` | Continue program execution and end the Pry session. |

### Callstack navigation

**backtrace:** Shows the current stack. You can use the numbers on the left
side with the `frame` command to navigate the stack.

**up:** Moves the stack frame up. Takes an optional numeric argument to move
multiple frames.

**down:** Moves the stack frame down. Takes an optional numeric argument to move
multiple frames.

**frame:** Moves to a specific frame. Called without arguments will show the
current frame.
| **Command** | **Description** |
|--------------|-------------------------------------------------------------------------------------------------------------------|
| `backtrace` | Shows the current stack. You can use the numbers on the left side with the `frame` command to navigate the stack. |
| `up` | Moves the stack frame up. Takes an optional numeric argument to move multiple frames. |
| `down` | Moves the stack frame down. Takes an optional numeric argument to move multiple frames. |
| `frame` | Moves to a specific frame. Called without arguments will show the current frame. |

## Matching Byebug Behaviour

Expand Down