lib/radiator/type/hash.rb
Missing top-level class documentation comment. Open
Open
class Hash < Serializer
- 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
Trailing whitespace detected. Open
Open
- Exclude checks
Unused method argument - value
. If it's necessary, use _
or _value
as an argument name to indicate that it won't be used. You can also write as initialize(*)
if you want the method to accept any arguments but don't care about them. Open
Open
def initialize(value)
- Read upRead up
- Exclude checks
This cop checks for unused method arguments.
Example:
# bad
def some_method(used, unused, _unused_but_allowed)
puts used
end
Example:
# good
def some_method(used, _unused, _unused_but_allowed)
puts used
end
Trailing whitespace detected. Open
Open
- Exclude checks