Skip to content
This repository was archived by the owner on Mar 12, 2023. It is now read-only.

Commit 6dcee20

Browse files
authored
Merge pull request #76 from camertron/copy_editing
Edit the documentation for spelling and grammar
2 parents c5c9064 + 42ca5c2 commit 6dcee20

24 files changed

+100
-100
lines changed

website/docs/commands/continue.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ slug: continue
77
| ------- | ------------------- | ----- |
88
| `continue` | F9 | `c` |
99

10-
Continue the execution of your program to the end, or stop at the first dynamic break point or `jard` attachment command.
10+
Continue the execution of your program until it finishes, or stop at the first dynamic break point or `jard` attachment command.

website/docs/commands/exit.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ slug: exit
77
| ------- | ------------------- | ----- |
88
| `exit` |||
99

10-
Exit the execution of the program. Interally, when `jard` receives this command, it removes all debugging hooks, and triggers `::Kernel.exit`. Some long-running processes like `puma` or `sidekiq` may capture this event, treat it as an error, and recover to keep the processes running. In such cases, it's recommended to use [continue](/docs/commands/continue) instead.
10+
Stop the execution of the program. Interally, when `jard` receives this command, it removes all debugging hooks, and triggers `::Kernel.exit`. Some long-running processes like `puma` or `sidekiq` may capture this event, treat it as an error, and recover to keep the processes running. In such cases, it's recommended to use [continue](/docs/commands/continue) instead.

website/docs/commands/filter.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import {LinkedImage} from '../../src/components/LinkedImage'
1212
| `jard filter clear` | | |
1313
| `jard filter switch` | | |
1414

15-
Ruby Jard has a strong filtering system. This system consists of a filter mode, included list, and excluded list. Filter mode is how Ruby Jard reacts to control flow commands. See [filter](/docs/guides/filter) for more information.
15+
Ruby Jard has a powerful filtering system. This system consists of a filter mode, include list, and exclude list. Filter mode is how Ruby Jard reacts to control flow commands. See the [filter docs](/docs/guides/filter) for more information.
1616

1717
**Examples:**
1818

website/docs/commands/frame.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ slug: frame
77
| ------- | ------------------- | ----- |
88
| `frame [-h] [frame_id]` || |
99

10-
Explore a particular frame with id `<frame_id>`. It's faster than `up` and `down`. See [up](/docs/commands/up) for more information.
10+
Explore a particular frame with id `<frame_id>`. This is faster than `up` and `down`. See the [up docs](/docs/commands/up) for more information.
1111

12-
[up](/docs/commands/up), [down](/docs/commands/down), and [frame](/docs/commands/frame) commands correlates to [filter](/docs/guides/filter). All hidden frames are ignored, all C frames are ignored too.
12+
[up](/docs/commands/up), [down](/docs/commands/down), and [frame](/docs/commands/frame) commands respect [filter](/docs/guides/filter). All hidden frames are ignored, all C frames are ignored too.
1313

1414
**Examples:**
1515

website/docs/commands/list.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ import {LinkedImage} from '../../src/components/LinkedImage'
88
| ------- | ------------------- | ----- |
99
| `list` | F5 | `l`, `whereami` |
1010

11-
Refresh the whole terminal UI. This command doesn't move you to other steps, nor change any data in your session. It is useful (or the only way) to get back the beautiful UI if you type too much in the REPL console.
11+
Refresh the whole terminal UI. This command doesn't move you to other steps or change any data in your session. It is the only way to reset the UI if you type too much in the REPL console.
1212

1313
<LinkedImage link="/img/commands/list.gif" alt="List example"/>

website/docs/commands/next.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ slug: next
77
| ------- | ------------------- | ----- |
88
| `next` | F8 | `n` |
99

10-
Continue to the next line in the current frame, by pass any steppable method call or blocks in the mid way unless they contains dynamic breakpoint or any `jard` attachment command. If the current frame already reaches the end, it continues to the next line of upper frame and so on.
10+
Continue to the next line in the current frame. Bypasses any steppable method call or block in between unless they contain a dynamic breakpoint or a `jard` attachment command. If execution has reached the end of the current frame, next continues to the next line of the parent frame and so on.
1111

1212
**Examples:**
1313

website/docs/commands/output.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import {LinkedImage} from '../../src/components/LinkedImage'
88
| ------- | ------------------- | ----- |
99
| `jard output` | | |
1010

11-
Show all the program output in a pager, allowing navigation, searching (powered by GNU Less). Note that the output are only captured only after Jard already started. All the previous output could not be captured.
11+
Show all program output in a pager, allowing navigation and searching (powered by GNU Less). Note that only the output emitted after Jard has started is captured. All the previous output will not be captured.
1212

1313
**Examples:**
1414

website/docs/commands/show.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ slug: show
77
| ------- | ------------------- | ----- |
88
| `jard show [screen]` | | |
99

10-
Show a particular screen on the current interface. This option correlates to recent layout's screens. If a screen is not available in current layout, it won't be shown.
10+
Show a particular screen in the current interface. This option correlates to recent layout's screens. If a screen is not available in current layout, it won't be shown.
1111

1212
**Examples:**
1313

website/docs/commands/skip.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ import {LinkedImage} from '../../src/components/LinkedImage'
88
| ------- | ------------------- | ----- |
99
| `skip [-a -all]` | | |
1010

11-
Continue the execution of your program to the end, and skip one, or more next breakpoints it meets. This command is useful when you puts `jard` command in an iteration or a nested method calls.
11+
Continue the execution of your program to the end, and skip one or more next breakpoints along the way. This command is useful when you put the `jard` command in an iteration or a nested method call.
1212

1313
**Note:**
14-
Ruby Jard resets skipping list in next attachment, or when your program exits. If you are running a web server, or background jobs that prevent your program from stopping, and you already skip all breakpoints, your program may not stop, and requires a restart to attach again.
14+
Ruby Jard resets the skip list in the next attachment or when your program exits. If you are running a web server or a background job that prevents your program from stopping (and you have already skipped all breakpoints), your program may not stop and may require a restart to attach again.
1515

1616
**Examples:**
1717

@@ -21,7 +21,7 @@ skip # Continue and skip the first breakpoint
2121
<LinkedImage link="/img/commands/skip.gif" alt="Skip example"/>
2222

2323
```
24-
skip 2 # Continue and skip the first 2 breakpoints it meets
24+
skip 2 # Continue and skip the first 2 breakpoints
2525
```
2626
<LinkedImage link="/img/commands/skip-2.gif" alt="Multiple skip example"/>
2727

website/docs/commands/step.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ slug: step
77
| ------- | ------------------- | ----- |
88
| `step` | F7 | `s` |
99

10-
Detect and step into a method call or block in the current line. If there isn't anything to step in, the program continues to next line. In case there are multiple methods on the same line, Jard hornors Ruby's execution order.
10+
Detect and step into a method call or block on the current line. If there isn't anything to step into, the program will continue to the next line. If there are multiple methods on the same line, Jard hornors Ruby's execution order.
1111

1212
**Examples:**
1313

website/docs/commands/step_out.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ import {LinkedImage} from '../../src/components/LinkedImage'
88
| ------- | ------------------- | ----- |
99
| `step-out` | Shift + F7 | `so` |
1010

11-
The opposite of step. This command is used to finish the execution of current frame, and jump to the next line of upper frame. In other words, this command is equivalent to the sequence `up` and `next`. If the neighbor frame already finishes, it continues with even higher frame.
11+
The opposite of step. This command is used to finish the execution of the current frame and jump to the next line of the parent frame. In other words, this command is equivalent to the sequence `up` and `next`. If the parent frame has already finished, Jard continues to the next line in that frame's parent and so on.
1212

13-
This command is useful when you loose your interest in frame, and want to quickly go up again. One example is that you accidentally step into a longgggg loop with nothing useful. Another example is that you step into the library source code and don't really care what it does underlying.
13+
This command is useful when you lose interest in a frame and want to easily return to the parent. For example, you might have accidentally stepped into a longgggg loop or into library source code.
1414

1515
**Examples:**
1616

website/docs/commands/up.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ import {LinkedImage} from '../../src/components/LinkedImage'
88
| ------- | ------------------- | ----- |
99
| `up` | F6 | |
1010

11-
Explore the upper frame. When you use this command, all associated displaying screens will be updated accordingly, but your program current position is still at the latest frame. This command is mostly used to explore, and view the trace, input parameters, or how your program stops at the current position. When use this command, you should have a glance at Variable panel, and Source panel to see the variables at destination frame.
11+
Explore the parent frame. When you use this command, all associated display screens will be updated accordingly, but your program's current position is still the latest frame. This command is mostly used to explore and introspect the stack, input parameters, or how your program has stopped at the current position. When using this command, take a look at the Variable and Source panels to see the variables defined in the current frame.
1212

13-
You can combine with `next` or `step` to perform powerful execution redirection at the destination frame. Let's look at an example. You are debugging a chain of 10 rack middlewares, you go deep into the #9 middleware, found something, then want to go back to #5 middleware. It's pretty boring and frustrated to just use `next` or `step-out` and hope it eventually goes back. Now use `up` for some times (or `frame`, described below) to go to your desired frame, and use `next` there. Tada, it's magical, just like teleport.
13+
You can combine `up` with `next` or `step` to perform powerful execution redirection at from the current frame. Let's look at an example. You are debugging a chain of 10 rack middlewares and you go deep into the ninth middleware. You find something and want to go back to the fifth middleware. It's pretty tedious and frustrating to use `next` or `step-out` and hope you eventually end up in the right place. Consider using `up` a few times (or `frame`, described below) to go to the desired frame, then use `next`. Tada! It's magical, like teleporting yourself to the right position.
1414

15-
[up](/docs/commands/up), [down](/docs/commands/down), and [frame](/docs/commands/frame) commands correlates to [filter](/docs/guides/filter). All hidden frames are ignored, all C frames are ignored too.
15+
[up](/docs/commands/up), [down](/docs/commands/down), and [frame](/docs/commands/frame) commands respect [filter](/docs/guides/filter). All hidden frames and C frames are ignored.
1616

1717
**Examples:**
1818

website/docs/guides/backtrace_screen.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,19 @@ import {LinkedImage} from '../../src/components/LinkedImage'
77

88
<LinkedImage link="/img/guides/backtrace-screen-1.png" alt="Backtrace screen"/>
99

10-
This screen describes the current backtrace of the current thread your program is stopping. Each line of this screen describes the current Frame. What is frame and backtrace by the way? Let's step back a little bit at how Ruby executes your code. Internally, Ruby uses an interpreter to read and execute your code, line by line (technically, YARD instructions, but let's go with a simple version). When it meets a chunk of code that needs to open a new scope, like method calls or inline-block call, the interpreter creates a new structure to store the current context so that it can link to the next scope and go back later. This data structure is call Frame. The interpreter pushes frame into a stack, called backtrace (or stack trace, or call stack, whatever), and continues to execute your code. Each thread has a separate backtrace. To understand deeply, you may be interested in this wonderful slide: [Grow and Shrink - Dynamically Extending the Ruby VM Stack](https://www.slideshare.net/KeitaSugiyama1/grow-and-shrink-dynamically-extending-the-ruby-vm-stack).
10+
This screen describes the backtrace of the current thread your program has stopped in. Each line of this screen describes the current Frame. What are frame and backtrace by the way? Let's step back a little bit and look at how Ruby executes your code. Internally, Ruby uses an interpreter to read and execute your code, line by line (technically it executes YARV instructions, but let's keep things simple). When it encounters a chunk of code that opens a new scope like a method call or inline block call, the interpreter creates a new structure to store the current context so that it can link to the next scope and go back later. This data structure is called a Frame. The interpreter pushes the frame onto a stack called the backtrace (or stack trace, or call stack, etc), and continues to execute your code. Each thread has a separate backtrace. To understand more deeply, you may be interested in this wonderful slide deck: [Grow and Shrink - Dynamically Extending the Ruby VM Stack](https://www.slideshare.net/KeitaSugiyama1/grow-and-shrink-dynamically-extending-the-ruby-vm-stack).
1111

12-
Overall, the whole backtrace screen lets you know where you are stopping at, the trace of how your program is running. When combining with other tools and other screens, you will be surprised by how much information the bugger can help you when you encounter your bugs.
12+
Overall, the whole backtrace screen lets you know where you've stopped, and shows you the trace of how your program is running. When combined with other tools and screens, you'll be surprised by how much information the debugger can give you when you're trying to track down a challenging bug.
1313

1414
Each frame includes the following information:
1515

16-
- Frame ID: incremental, can be used to jump to an arbitrary frame with frame command.
16+
- Frame ID: incremental, can be used to jump to an arbitrary frame with the frame command.
1717
- Location label: a class name and method name of the method covers its frame.
1818
- Physical location: exact file name and line number.
1919
- If a frame is allocated in a gem, the physical location shows a gem name and version only. For example: `Calendar::GeneratedAssociationMethods in events in <activerecord 6.0.3.1>`.
20-
- If there is a `[c]` prefix in front of a class name, it means that the method is provided by Ruby, implemented in C, and impossible to peek, for example. For example: `[c] Range in each at test5.rb:11`.
21-
- If a frame is from standardlib, the location has `stdlib` prefix. For example: `Random::Formatter in uuid in <stdlib:securerandom>`
20+
- If there is a `[c]` prefix in front of a class name, it means that the method is provided by Ruby, implemented in C, and impossible to peek at. For example: `[c] Range in each at test5.rb:11`.
21+
- If a frame is from standard library, the location has the `stdlib` prefix. For example: `Random::Formatter in uuid in <stdlib:securerandom>`
2222

23-
If a frame is filtered out, it won't be displayed. The top title displays overall hidden frames. To navigate through the backtrace, you can use [filter feature](/docs/guides/filter) combine with [up command](/docs/commands/up), [down command](/docs/commands/down), and [frame command](/docs/commands/frame).
23+
If a frame is filtered out, it won't be displayed. The top title displays overall hidden frames. To navigate through the backtrace, you can use the [filter feature](/docs/guides/filter) combined with the [up command](/docs/commands/up), [down command](/docs/commands/down), and [frame command](/docs/commands/frame).
2424

2525
<LinkedImage link="/img/guides/backtrace-screen-2.gif" alt="Navigate and explore backtrace"/>

website/docs/guides/color_schemes.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ id: Color schemes
33
slug: color-schemes
44
---
55

6-
Ruby Jard bundles 6 built-in schemes, 4 dark ones, and 2 light ones. You can use [color scheme commands](/docs/commands/color-scheme) to up the flight, or define in [configuration file](/docs/guides/configurations).
6+
Ruby Jard bundles 6 built-in schemes: 4 dark ones and 2 light ones. You can use [color scheme commands](/docs/commands/color-scheme) to set the current scheme, or define in [configuration file](/docs/guides/configurations).
77

88
### 256
9-
Default scheme, 256 basic colors, supported by all terminals
9+
Default scheme. 256 basic colors, supported by all terminals
1010

1111
![256 Color scheme](/img/color_schemes/256.png)
1212

@@ -33,7 +33,7 @@ Light 256 basic colors
3333

3434
### Your custom theme
3535

36-
Add those lines into your [configuration file](/docs/guides/configurations). Ruby Jard supports two types of colors: 24-bit color or [ANSI 8-bit color](https://en.wikipedia.org/wiki/ANSI_escape_code).
36+
Add these lines into your [configuration file](/docs/guides/configurations). Ruby Jard supports two types of colors: 24-bit color and [ANSI 8-bit color](https://en.wikipedia.org/wiki/ANSI_escape_code).
3737

3838
```ruby
3939
class MyColorScheme < ColorScheme

website/docs/guides/configurations.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,19 @@ id: Configurations
33
slug: configurations
44
---
55

6-
Ruby Jard supports customization via pre-loaded configuration files. You can configure Jard both globally, and per-project.
6+
Ruby Jard supports customization via preloaded configuration files. You can configure Jard both globally and on a per-project basis.
77

8-
- If `JARD_CONFIG_FILE` environment variable is available, Jard uses that file.
8+
- If the `JARD_CONFIG_FILE` environment variable is available, Jard uses that file.
99
- The global configuration file is located at `~/.jardrc`.
10-
- The project configuration file is located at `.jardrc` in working directory when you start Ruby Jard. Per-project ones override the global one.
10+
- The project configuration file is located at `.jardrc` in the current working directory when you start Ruby Jard. Per-project configs override the global one.
1111

12-
There are some supported configurations:
12+
Here are some supported configurations:
1313

1414
| Name | Description | Default | Values |
1515
| ------------------- | ------------------------------------------------------------ | ------- | ------ |
1616
| `color_scheme` | Choose your favorite color scheme. See [color schemes page](/docs/guides/color-schemes) for more information.| `256` | See [color-scheme command](/docs/commands/color-scheme) |
1717
| `layout` | By default, Ruby Jard chooses the layout based on current window size. This option allows you to force a layout. | `nil` | `nil`, `tiny`, `wide`, `narrow-vertical`, `narrow-horizontal` |
18-
| `enabled_screens` | Force display a subset of screens. This option correlates with recent layout's screens. | `[]` | `backtrace`, `menu`, `source`, `threads`, `variables`|
18+
| `enabled_screens` | Force display of a subset of screens. This option correlates with the recent layout's screens. | `[]` | `backtrace`, `menu`, `source`, `threads`, `variables`|
1919
| `filter` | Filter mode. See [filter page](/docs/guides/filter) for more information | `:application` | `:everything`, `:gems`, `:application`, `:source_tree`|
2020
| `filter_included` | Filter included pattern. See [filter page](/docs/guides/filter) for more information | `[]` | |
2121
| `filter_excluded` | Filter excluded pattern. See [filter page](/docs/guides/filter) for more information | `[]` | |

0 commit comments

Comments
 (0)