Missing top-level class documentation comment. Open
class Item < Resource
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.
# bad class Person # ... end # good # Description/Explanation of Person class class Person # ... end
Surrounding space missing in default value assignment. Open
Checks that the equals signs in parameter default assignments have or don't have surrounding space depending on configuration.
# bad def some_method(arg1=:default, arg2=nil, arg3=) # do something... end # good def some_method(arg1 = :default, arg2 = nil, arg3 = ) # do something... end