Sign upLogin

CoolElvis/gt06_server

View on GitHub
Star
lib/gt06_server/messages/login_message.rb

Summary

Maintainability
A
0 mins
Test Coverage

Gt06Server::Messages::LoginMessage has no descriptive comment
Open

    class LoginMessage < BinData::Record
Severity: Minor
Found in lib/gt06_server/messages/login_message.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

Incorrect indentation detected (column 6 instead of 8).
Open

      # Description Bits Example
Severity: Minor
Found in lib/gt06_server/messages/login_message.rb by rubocop

This cops checks the indentation of comments.

Example:

# bad
  # comment here
def method_name
end

  # comment here
a = 'hello'

# yet another comment
  if true
    true
  end

# good
# comment here
def method_name
end

# comment here
a = 'hello'

# yet another comment
if true
  true
end

Incorrect indentation detected (column 8 instead of 6).
Open

        # Stop Bit 2 0x0D 0x0
Severity: Minor
Found in lib/gt06_server/messages/login_message.rb by rubocop

This cops checks the indentation of comments.

Example:

# bad
  # comment here
def method_name
end

  # comment here
a = 'hello'

# yet another comment
  if true
    true
  end

# good
# comment here
def method_name
end

# comment here
a = 'hello'

# yet another comment
if true
  true
end

There are no issues that match your filters.

Category
Status