lib/basquiat/adapters/rabbitmq/requeue_strategies/basic_acknowledge.rb
Basquiat::Adapters::RabbitMq::BasicAcknowledge has no descriptive comment Open
Open
class BasicAcknowledge < BaseStrategy
- Read upRead up
- Create a ticketCreate a ticket
- Exclude checks
Classes and modules are the units of reuse and release. It is therefore considered good practice to annotate every class and module with a brief comment outlining its responsibilities.
Example
Given
class Dummy
# Do things...
end
Reek would emit the following warning:
test.rb -- 1 warning:
[1]:Dummy has no descriptive comment (IrresponsibleModule)
Fixing this is simple - just an explaining comment:
# The Dummy class is responsible for ...
class Dummy
# Do things...
end