Contents

# Style guide

## Instance variables and getters / setters

We use instance vars only:

- in the constructor
- for [memoization](http://gavinmiller.io/2013/basics-of-ruby-memoization/)

For everything else we use proper getters / setters.

If possible those should be private.

## Data types

- Class or module names that are carried around in hashes and configuration and what
not should be designated by constants. So `DuplicateMethodCall`, not `:DuplicateMethodCall` or `"DuplicateMethodCall"`
- Hash keys should be all symbols unless they designate classes / modules - see above.
- Everything else like messages or parameters in smell warnings should be strings, nothing else.

Version data entries

37 entries across 35 versions & 2 rubygems

Version	Path
reek-6.0.3	docs/Style-Guide.md
reek-6.0.2	docs/Style-Guide.md
reek-6.0.1	docs/Style-Guide.md
reek-6.0.0	docs/Style-Guide.md
reek-5.6.0	docs/Style-Guide.md
reek-5.5.0	docs/Style-Guide.md
reek-5.4.1	docs/Style-Guide.md
reek-5.4.0	docs/Style-Guide.md
reek-5.3.2	docs/Style-Guide.md
reek-5.3.1	docs/Style-Guide.md
reek-5.3.0	docs/Style-Guide.md
config_gems_initialization_aim-0.1.4	vendor/bundle/ruby/2.5.0/gems/reek-5.2.0/docs/Style-Guide.md
config_gems_initialization_aim-0.1.4	vendor/bundle/ruby/2.5.0/gems/config_gems_initialization_aim-0.1.1/vendor/bundle/ruby/2.5.0/gems/reek-5.2.0/docs/Style-Guide.md
config_gems_initialization_aim-0.1.3	vendor/bundle/ruby/2.5.0/gems/reek-5.2.0/docs/Style-Guide.md
config_gems_initialization_aim-0.1.3	vendor/bundle/ruby/2.5.0/gems/config_gems_initialization_aim-0.1.1/vendor/bundle/ruby/2.5.0/gems/reek-5.2.0/docs/Style-Guide.md
reek-5.2.0	docs/Style-Guide.md
reek-5.1.0	docs/Style-Guide.md
reek-5.0.2	docs/Style-Guide.md
reek-5.0.1	docs/Style-Guide.md
reek-5.0.0	docs/Style-Guide.md