lib/dumpman/adapters/pg.rb
Dumpman::Adapters::Pg has no descriptive comment Open
Open
class Pg < Base- 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...
endLine is too long. [91/80] Open
Open
"PGPASSWORD='#{password}' createdb -h #{host} --username '#{username}' #{database}"- Exclude checks
Line is too long. [161/80] Open
Open
"PGPASSWORD='#{password}' pg_dump -h #{host} --username '#{username}' --verbose --clean --no-owner --no-acl -Z4 -Fc #{database} > '#{Dumpman.dump_file}'"- Exclude checks
Line is too long. [89/80] Open
Open
"PGPASSWORD='#{password}' dropdb -h #{host} --username '#{username}' #{database}"- Exclude checks
Line is too long. [162/80] Open
Open
"PGPASSWORD='#{password}' pg_restore -h #{host} --username '#{username}' --verbose --clean --no-owner --no-acl -j 4 -d #{database} '#{Dumpman.dump_file}'"- Exclude checks
Missing top-level class documentation comment. Open
Open
class Pg < Base- 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