Name your test subject if you need to reference it explicitly. Open
in_stage :prepare_to_validate, on: :create, trigger: -> { subject } do
- Create a ticketCreate a ticket
- Exclude checks
Missing top-level module documentation comment. Open
module Phrase
- 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
Name your test subject if you need to reference it explicitly. Open
in_stage :prepare_to_validate, on: :create, trigger: -> { subject } do
- Create a ticketCreate a ticket
- Exclude checks
Missing top-level module documentation comment. Open
module Write
- 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
Start context description with 'when', 'with', or 'without'. Open
context "if accessor type is defined by a symbol" do
- Create a ticketCreate a ticket
- Exclude checks
Missing top-level module documentation comment. Open
module Read
- 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
Start context description with 'when', 'with', or 'without'. Open
context "if accessor type is defined by an id" do
- Create a ticketCreate a ticket
- Exclude checks