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.

Sign up for GitHub

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

Jump to bottom

[docs] Avoid a typo in upgrade instructions #1468

Merged
merged 2 commits into from Mar 22, 2019
Merged

[docs] Avoid a typo in upgrade instructions #1468

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
76ec76e
[docs] Avoid a typo
olleolleolle Mar 22, 2019
f96a8cf
[docs] Use a diff block
olleolleolle Mar 22, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 6 additions & 11 deletions docs/Reek-4-to-Reek-5-migration.md
View file
Open in desktop
Expand Up @@ -175,18 +175,13 @@ reek_of('DuplicateMethodCall')
* `wiki-links` flag has been renamed to `documentation` flag
* Reek assumes the default configuration file to be named ".reek.yml" and will ignore all other files. You can
still use any name you want though by passing in a name via the `-c` flag
* We have dropped the legacy code comment separator ":" at the end of a detector name. If you wanted to configure
a smell detector via comment before this release you had to use g like this:
* We have dropped the legacy code comment separator `:` at the end of a detector name. Before this release,
to configure a smell detector via comment, you had to end with a colon after the detector name.
This syntax is disallowed with Reek 5 - now you have to drop the `:` at the end, like this:

```
# :reek:UnusedPrivateMethod: { exclude: [ bravo ] }
```

Mind the ":" at the end of "UnusedPrivateMethod". This syntax is disallowed with Reek 5 - you have to drop the ":"
at the end now like this:

```
# :reek:UnusedPrivateMethod { exclude: [ bravo ] }
```diff
-# :reek:UnusedPrivateMethod: { exclude: [ bravo ] }
+# :reek:UnusedPrivateMethod { exclude: [ bravo ] }
Copy link
Collaborator

Choose a reason for hiding this comment

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

Nice! I didn't know you could do that.

Copy link
Owner

Choose a reason for hiding this comment

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

Yeah, I also learned something :D

```

* We have dropped support for Ruby 2.1 and 2.2 since they are officially not supported by the Ruby core team anymore
Expand Down