TheCorrespondingSquares/chess-app

View on GitHub
app/helpers/dashboards_helper.rb

Summary

Maintainability
A
0 mins
Test Coverage

Missing top-level module documentation comment.
Open

module DashboardsHelper
Severity: Minor
Found in app/helpers/dashboards_helper.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

There are no issues that match your filters.

Category
Status