lib/reek/smells/smell_detector.rb in reek-2.1.0 vs lib/reek/smells/smell_detector.rb in reek-2.2.0
- old
+ new
@@ -1,13 +1,17 @@
require 'set'
-require_relative '../smell_warning'
require_relative '../core/smell_configuration'
module Reek
module Smells
#
# Shared responsibilities of all smell detectors.
#
+ # See
+ # - docs/Basic-Smell-Options
+ # - docs/Code-Smells
+ # - docs/Configuration-Files
+ # for details.
class SmellDetector
attr_reader :source
# The name of the config field that lists the names of code contexts
# that should not be checked. Add this field to the config for each