Sign upLogin

sanger/sequencescape

View on GitHub
Star
app/api/core/logging.rb

Summary

Maintainability
A
0 mins
Test Coverage
A
100%

Core::Logging has no descriptive comment
Open

module Core::Logging
Severity: Minor
Found in app/api/core/logging.rb by reek

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

Core::Logging#low_level has unused parameter 'args'
Open

  def low_level(*args)
Severity: Minor
Found in app/api/core/logging.rb by reek

Unused Parameter refers to methods with parameters that are unused in scope of the method.

Having unused parameters in a method is code smell because leaving dead code in a method can never improve the method and it makes the code confusing to read.

Example

Given:

class Klass
  def unused_parameters(x,y,z)
    puts x,y # but not z
  end
end

Reek would emit the following warning:

[2]:Klass#unused_parameters has unused parameter 'z' (UnusedParameters)

There are no issues that match your filters.

Category
Status