Dumpman::Commandor has no descriptive comment Open
module Commandor
- 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...
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
Dumpman::Commandor#drop_db doesn't depend on instance state (maybe move it to another class?) Open
def drop_db
- Read upRead up
- Exclude checks
A Utility Function is any instance method that has no dependency on the state of the instance.
Dumpman::Commandor#dump doesn't depend on instance state (maybe move it to another class?) Open
def dump
- Read upRead up
- Exclude checks
A Utility Function is any instance method that has no dependency on the state of the instance.
Dumpman::Commandor#restore doesn't depend on instance state (maybe move it to another class?) Open
def restore
- Read upRead up
- Exclude checks
A Utility Function is any instance method that has no dependency on the state of the instance.
Dumpman::Commandor#create_db doesn't depend on instance state (maybe move it to another class?) Open
def create_db
- Read upRead up
- Exclude checks
A Utility Function is any instance method that has no dependency on the state of the instance.
Missing top-level module documentation comment. Open
module Commandor
- 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
Use module_function
instead of extend self
. Open
extend self
- Read upRead up
- Exclude checks
This cops checks for use of extend self
or module_function
in a
module.
Supported styles are: modulefunction, extendself.
Example: EnforcedStyle: module_function (default)
# bad
module Test
extend self
# ...
end
# good
module Test
module_function
# ...
end
Example: EnforcedStyle: extend_self
# bad
module Test
module_function
# ...
end
# good
module Test
extend self
# ...
end
These offenses are not auto-corrected since there are different implications to each approach.