Miscellaneous docs improvements #193
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #193 +/- ##
=======================================
Coverage 58.95% 58.95%
=======================================
Files 7 7
Lines 441 441
Branches 120 120
=======================================
Hits 260 260
Misses 173 173
Partials 8 8Continue to review full report at Codecov.
|
aoberoi
approved these changes
May 16, 2019
docs/_advanced/error_handling.md
Outdated
| @@ -5,7 +5,7 @@ order: 1 | |||
| --- | |||
|
|
|||
| <div class="section-content"> | |||
| If an error occurs in a listener, it’s recommended you handle it directly. However, there are cases where errors may occur after your listener middleware has returned (such as `say()`, `respond()`, or not calling `ack()`). By default, these errors will be logged to the console. To handle them yourself, you can attach a global error handler to your app using the `error(fn)` method. | |||
| If an error occurs in a listener, it’s recommended you handle it directly. However, there are cases where errors may be triggered after your listener middleware has already returned (such as in `say()`, `respond()`, or if you don't call `ack()` when it's required). By default, these errors will be logged to the console. To handle them yourself, you can attach a global error handler to your app with the `error(fn)` method. | |||
There was a problem hiding this comment.
I think its important to be consistent with "listener" versus "listener middleware", and it seems like we are using both in the two clauses of this sentence.
|
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Mostly just small wording changes that hopefully make some sections a little clearer.
Requirements (place an
xin each[ ])