lib/oxblood/commands/lists.rb
Line is too long. [82/80] Open
Open
# @return [String] the requested element, or nil when index is out of range.
- Exclude checks
Line is too long. [81/80] Open
Open
# @return [String, nil] the value of the last element, or nil when key does
- Exclude checks
Missing top-level module documentation comment. Open
Open
module Lists
- 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