lib/hg.rb
TODO found Open
Open
# TODO: Move to Bot itself, default to User.
- Create a ticketCreate a ticket
- Exclude checks
TODO found Open
Open
# TODO: List subordinate requires in their respective files.
- Create a ticketCreate a ticket
- Exclude checks
Missing top-level module documentation comment. Open
Open
module Hg
- Read upRead up
- Create a ticketCreate a ticket
- 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