andypike/rectify

View on GitHub
lib/rectify/rspec/database_reporter/display.rb

Summary

Maintainability
A
0 mins
Test Coverage

Rectify::RSpec::DatabaseReporter::Display has no descriptive comment
Open

      class Display

Classes and modules are the units of reuse and release. It is therefore considered good practice to annotate every class and module with a brief comment outlining its responsibilities.

Example

Given

class Dummy
  # Do things...
end

Reek would emit the following warning:

test.rb -- 1 warning:
  [1]:Dummy has no descriptive comment (IrresponsibleModule)

Fixing this is simple - just an explaining comment:

# The Dummy class is responsible for ...
class Dummy
  # Do things...
end

There are no issues that match your filters.

Category
Status