Sha256: d882ffa8e8526978ccc56ffcc1ef0eca573026a0ba9a2f09556be3bcf393c26a
Contents?: true
Size: 1.16 KB
Versions: 3
Compression:
Stored size: 1.16 KB
Contents
## Introduction Classes should use their private methods. Otherwise this is dead code which is confusing and bad for maintenance. The `Unused Private Method` detector reports unused private instance methods and instance methods only - class methods are ignored. ## Example Given: ```Ruby class Car private def drive; end def start; end end ``` `Reek` would emit the following warning: ``` 2 warnings: [3]:Car has the unused private instance method `drive` (UnusedPrivateMethod) [4]:Car has the unused private instance method `start` (UnusedPrivateMethod) ``` ## Configuration `Unused Private Method` offers the [Basic Smell Options](Basic-Smell-Options.md). Private methods that are called via dynamic dispatch will trigger a false alarm since detecting something like this is far out of scope for `Reek`. In this case you can disable this detector via the `exclude` configuration option (which is part of the [Basic Smell Options](Basic-Smell-Options.md)) for instance like this (an example from `Reek's` own codebase): ```Ruby # :reek:UnusedPrivateMethod: { exclude: [ !ruby/regexp /process_/ ] } class ContextBuilder def process_begin # .... end end ```
Version data entries
3 entries across 3 versions & 1 rubygems
Version | Path |
---|---|
reek-3.8.2 | docs/Unused-Private-Method.md |
reek-3.8.1 | docs/Unused-Private-Method.md |
reek-3.8.0 | docs/Unused-Private-Method.md |