Sign upLogin

vital-edu/sala-de-espera

View on GitHub
Star
app/controllers/static_pages_controller.rb

Summary

Maintainability
A
0 mins
Test Coverage

Missing method documentation comment.
Open

  def home
    @images = Dir.glob('app/assets/images/carousel/*.{png,jpg,jpeg,gif}')
    @service_category = ServiceCategory.all
  end
Severity: Minor
Found in app/controllers/static_pages_controller.rb by rubocop

This cop checks for missing documentation comment for public methods. It can optionally be configured to also require documentation for non-public methods.

Example:

# bad

class Foo
  def bar
    puts baz
  end
end

module Foo
  def bar
    puts baz
  end
end

def foo.bar
  puts baz
end

# good

class Foo
  # Documentation
  def bar
    puts baz
  end
end

module Foo
  # Documentation
  def bar
    puts baz
  end
end

# Documentation
def foo.bar
  puts baz
end

Missing top-level class documentation comment.
Open

class StaticPagesController < ApplicationController
Severity: Minor
Found in app/controllers/static_pages_controller.rb by rubocop

This cop checks for missing top-level documentation of classes and modules. Classes with no body are exempt from the check and so are namespace modules - modules that have nothing in their bodies except classes, other modules, or constant definitions.

The documentation requirement is annulled if the class or module has a "#:nodoc:" comment next to it. Likewise, "#:nodoc: all" does the same for all its children.

Example:

# bad
class Person
  # ...
end

# good
# Description/Explanation of Person class
class Person
  # ...
end

There are no issues that match your filters.

Category
Status