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 a false positive for RSpec/ExampleWithoutDescription when specify with multi-line block and missing description #1805

Merged
merged 1 commit into from
Feb 17, 2024

Conversation

ydah
Copy link
Member

@ydah ydah commented Feb 15, 2024

This PR fixes a false positive for RSpec/ExampleWithoutDescription when specify with multi-line block and missing description. This is because specify is recommended when there is no description.

refs: https://rspec.rubystyle.guide/#it-and-specify

# good
specify do
  # ...
end

Before submitting the PR make sure the following are checked:

  • Feature branch is up-to-date with master (if not - rebase it).
  • Squashed related commits together.
  • Added tests.
  • Updated documentation.
  • Added an entry to the CHANGELOG.md if the new code introduces user-observable changes.
  • The build (bundle exec rake) passes (be sure to run this locally, since it may produce updated documentation that you will need to commit).

@ydah ydah requested a review from a team as a code owner February 15, 2024 11:46
@ydah ydah mentioned this pull request Feb 15, 2024
12 tasks
Copy link
Member

@pirj pirj left a comment

Choose a reason for hiding this comment

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

Thank you!

@ydah ydah force-pushed the fix-false-positive-example-without-description branch 2 times, most recently from 7ca2e33 to 614c7ab Compare February 17, 2024 14:47
…ify` with multi-line block and missing description

This PR fixes a false positive for `RSpec/ExampleWithoutDescription` when `specify` with multi-line block and missing description.
This is because `specify` is recommended when there is no description.

refs: https://rspec.rubystyle.guide/#it-and-specify

```ruby
specify do
  # ...
end
```
@ydah ydah force-pushed the fix-false-positive-example-without-description branch from 614c7ab to 20311f5 Compare February 17, 2024 14:48
@ydah ydah merged commit b5f1e25 into master Feb 17, 2024
24 checks passed
@ydah ydah deleted the fix-false-positive-example-without-description branch February 17, 2024 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants