LolDba::SqlGenerator has no descriptive comment Open
class SqlGenerator- Read upRead up
- Exclude checks
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...
endReek 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...
endLolDba::SqlGenerator#migrator doesn't depend on instance state (maybe move it to another class?) Open
def migrator- Read upRead up
- Exclude checks
A Utility Function is any instance method that has no dependency on the state of the instance.
LolDba::SqlGenerator#specific_migration has the variable name 'm' Open
migration = migrator.migrations.find { |m| m.version == which.to_i }- Read upRead up
- Exclude checks
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.
Missing top-level class documentation comment. Open
class SqlGenerator- Read upRead up
- Exclude checks
This cop checks for missing top-level documentation of classes and modules. Classes with no body are exempt from the check and so are namespace modules - modules that have nothing in their bodies except classes, other modules, or constant definitions.
The documentation requirement is annulled if the class or module has a "#:nodoc:" comment next to it. Likewise, "#:nodoc: all" does the same for all its children.
Example:
# bad
class Person
# ...
end
# good
# Description/Explanation of Person class
class Person
# ...
end