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

Fix minor errata on debugging section [ci-skip] #45391

Merged
merged 1 commit into from Jun 18, 2022
Merged

Fix minor errata on debugging section [ci-skip] #45391

merged 1 commit into from Jun 18, 2022

Conversation

siaw23
Copy link
Member

@siaw23 siaw23 commented Jun 17, 2022

Summary

Other Information

@rails-bot rails-bot bot added the docs label Jun 17, 2022
Copy link
Member

@jonathanhefner jonathanhefner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catches! 👍

@@ -436,13 +436,12 @@ It's also possible to use these options together: `backtrace [num] /pattern/`.

#### The outline command

This command is similar to `pry` and `irb`'s `ls` command. It will show you what's accessible from you current scope, including:
This command is similar to `pry` and `irb`'s `ls` command. It will show you what's accessible from the current scope which among others, include:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, "including:" still reads more naturally to me.

Suggested change
This command is similar to `pry` and `irb`'s `ls` command. It will show you what's accessible from the current scope which among others, include:
This command is similar to `pry` and `irb`'s `ls` command. It will show you what's accessible from the current scope, including:

@@ -491,7 +490,7 @@ And to remove them, you can use:

#### The break command

**Set a breakpoint with specified line number - e.g. `b 28`**
**Set a breakpoint with the specified line number - e.g. `b 28`**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**Set a breakpoint with the specified line number - e.g. `b 28`**
**Set a breakpoint on a specified line number - e.g. `b 28`**

@@ -532,7 +531,7 @@ And to remove them, you can use:
Stop by #0 BP - Line /Users/st0012/projects/rails-guide-example/app/controllers/posts_controller.rb:28 (line)
```

**Set a breakpoint on a given method call - e.g. `b @post.save`**
**Set a breakpoint on the given method call - e.g. `b @post.save`**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here, I think "a given method call" reads more naturally than "the given method call", because "given method call" has not yet been introduced. If there were another sentence following this one, then it may be more natural to refer to "the given method call" in that sentence, e.g. "If the given method call contains invalid syntax...".

Suggested change
**Set a breakpoint on the given method call - e.g. `b @post.save`**
**Set a breakpoint on a given method call - e.g. `b @post.save`**

@siaw23
Copy link
Member Author

siaw23 commented Jun 18, 2022

All good @jonathanhefner

@jonathanhefner jonathanhefner merged commit 9a7d442 into rails:main Jun 18, 2022
@jonathanhefner
Copy link
Member

jonathanhefner commented Jun 18, 2022

Thank you, @siaw23! 😄

(Backported to 7-0-stable.)

jonathanhefner added a commit to jonathanhefner/rails that referenced this pull request Jun 25, 2022
Fix minor errata on debugging section [ci-skip]

(cherry picked from commit 9a7d442)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants