[Fix #7495] Documentation for Lint/AmbiguousBlockAssociation cop is confusing
#8850
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
marcandre
requested changes
Oct 5, 2020
| @@ -15,6 +15,8 @@ module Lint | |||
| # | |||
| # # good | |||
| # # With parentheses, there's no ambiguity. | |||
| # some_method(a { |val| puts val }) | |||
| # # or | |||
There was a problem hiding this comment.
How about # or (different meaning):
|
Also the offense message would be best with quotes, if you'd like to do that too... Parenthesize the param a { |val| puts val } to make sure that the block will be associated with the a method call.
# to
Parenthesize the param `a { |val| puts val }` to make sure that the block will be associated with the `a` method call. |
Add example on documentation for `Lint/AmbiguousBlockAssociation` to make clear the possible resolutions
AllanSiqueira
force-pushed
the
add-example-documentation-lint-ambiguous-block-association
branch
from
9efbb04
to
ef85068
Compare
I search for this and seems like it already has quotes, there is somewhere who hasn't the quotes and I let pass? |
Oh, perfect. I got that message from the original issue only, didn't check. |
|
Thanks for the PR! 👍 |
AllanSiqueira
deleted the
add-example-documentation-lint-ambiguous-block-association
branch
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.
Fixes: #7495
Add an example in the documentation for
Lint/AmbiguousBlockAssociationto illustrate both good solutions for this cop.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.