Change AllowComments of Lint/SuppressedException to true by default
#7805
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
## Summary Follow rubocop#7052 (comment). This PR changes `AllowComments` option of `Lint/SuppressedException` to true by default. As is used in RuboCop repo itself, it is a common practice to use source code comments to explain when exception handling is not performed. ## Related Information I think that `Suppressing Exceptions` rule can be refined to a suitable example. https://github.com/rubocop-hq/ruby-style-guide#dont-hide-exceptions
Agreed. |
koic
added a commit
to koic/ruby-style-guide
that referenced
this pull request
Mar 20, 2020
Follow up of rubocop/rubocop#7805 (comment). This PR refines an example for "Suppressing Exceptions" rule. And `do_something rescue nil` will be changed from bad case to good case based on RuboCop (0.81)'s behavior and the comment below. rubocop/rubocop#7297 (comment)
bbatsov
pushed a commit
to rubocop/ruby-style-guide
that referenced
this pull request
Mar 20, 2020
Follow up of rubocop/rubocop#7805 (comment). This PR refines an example for "Suppressing Exceptions" rule. And `do_something rescue nil` will be changed from bad case to good case based on RuboCop (0.81)'s behavior and the comment below. rubocop/rubocop#7297 (comment)
8 tasks
koic
added a commit
to koic/rubocop
that referenced
this pull request
May 10, 2020
Fixes rubocop#3696 and rubocop#3754. This PR add `AllowComments` option to `Lint/EmptyWhen` cop. This option is enabled by default based on user feedback. It is also the same default as the option of `Lint/SuppressedException` set in rubocop#7805.
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
Follow #7052 (comment).
This PR changes
AllowCommentsoption ofLint/SuppressedExceptionto true by default.As is used in RuboCop repo itself, it is a common practice to use source code comments to explain when exception handling is not performed.
Related Information
I think that
Suppressing Exceptionsrule can be refined to a suitable example.https://github.com/rubocop-hq/ruby-style-guide#dont-hide-exceptions
Before submitting the PR make sure the following are checked:
[Fix #issue-number](if the related issue exists).master(if not - rebase it).bundle exec rake default. It executes all tests and RuboCop for itself, and generates the documentation.