Sign upLogin

Trevoke/SGFParser

View on GitHub
Star
lib/sgf/error.rb

Summary

Maintainability
A
0 mins
Test Coverage

SGF::MalformedDataError has no descriptive comment
Open

  class MalformedDataError < StandardError
Severity: Minor
Found in lib/sgf/error.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

SGF::NoIdentityError has no descriptive comment
Open

  class NoIdentityError < StandardError
Severity: Minor
Found in lib/sgf/error.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

SGF::FormatNotSpecifiedWarning has no descriptive comment
Open

  class FormatNotSpecifiedWarning < StandardError
Severity: Minor
Found in lib/sgf/error.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

There are no issues that match your filters.

Category
Status