lib/sapience/extensions/action_view/streaming_template_renderer.rb
Line is too long. [84/80] Open
Open
class ActionView::StreamingTemplateRenderer # rubocop:disable ClassAndModuleChildren- Exclude checks
Missing top-level class documentation comment. Open
Open
class Body- 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
# ...
endAdd an empty line after magic comments. Open
Open
# Log actual exceptions, not a string representation- Read upRead up
- Exclude checks
Checks for a newline after the final magic comment.
Example:
# good
# frozen_string_literal: true
# Some documentation for Person
class Person
# Some code
end
# bad
# frozen_string_literal: true
# Some documentation for Person
class Person
# Some code
end