Sign upLogin

decko-commons/decko

View on GitHub
Star
mod/history/lib/card/act/act_renderer.rb

Summary

Maintainability
A
0 mins
Test Coverage
A
90%

Missing top-level class documentation comment.
Open

    class ActRenderer
Severity: Minor
Found in mod/history/lib/card/act/act_renderer.rb by rubocop

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

When using method_missing, fall back on super.
Open

      def method_missing method_name, *args, &block
        if block_given?
          @format.send(method_name, *args, &block)
        else
          @format.send(method_name, *args)
Severity: Minor
Found in mod/history/lib/card/act/act_renderer.rb by rubocop

This cop checks for the presence of method_missing without also defining respond_to_missing? and falling back on super.

Example:

#bad
def method_missing(name, *args)
  # ...
end

#good
def respond_to_missing?(name, include_private)
  # ...
end

def method_missing(name, *args)
  # ...
  super
end

There are no issues that match your filters.

Category
Status