Sign upLogin

18F/confidential-survey

View on GitHub
Star
db/migrate/20160225220247_create_tokens_table.rb

Summary

Maintainability
A
0 mins
Test Coverage

CreateTokensTable has no descriptive comment
Open

class CreateTokensTable < ActiveRecord::Migration
Severity: Minor
Found in db/migrate/20160225220247_create_tokens_table.rb by reek

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

CreateTokensTable#change has the variable name 't'
Open

    create_table :survey_tokens do |t|
Severity: Minor
Found in db/migrate/20160225220247_create_tokens_table.rb by reek

An Uncommunicative Variable Name is a variable name that doesn't communicate its intent well enough.

Poor names make it hard for the reader to build a mental picture of what's going on in the code. They can also be mis-interpreted; and they hurt the flow of reading, because the reader must slow down to interpret the names.

There are no issues that match your filters.

Category
Status