app/helpers/orders_helper.rb
OrdersHelper has no descriptive comment Open
Open
module OrdersHelper
- Read upRead up
- 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
OrdersHelper#order_count doesn't depend on instance state (maybe move it to another class?) Open
Open
def order_count(order)
- Read upRead up
- Exclude checks
A Utility Function is any instance method that has no dependency on the state of the instance.