Sign upLogin

sanger/sequencescape

View on GitHub
Star
lib/api_tools.rb

Summary

Maintainability
A
0 mins
Test Coverage
C
72%

ApiTools has no descriptive comment
Open

module ApiTools
Severity: Minor
Found in lib/api_tools.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

ActiveRecord::Base has no descriptive comment
Open

class ActiveRecord::Base
Severity: Minor
Found in lib/api_tools.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

ApiTools::ClassMethods has no descriptive comment
Open

  module ClassMethods
Severity: Minor
Found in lib/api_tools.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

TODO found
Open

  # TODO: Add relationships for object
Severity: Minor
Found in lib/api_tools.rb by fixme

There are no issues that match your filters.

Category
Status