Ruby

Ruby

By DeepSource

Documentation missing for public method RB-ST1032

Documentation

Public methods should have documentation.

Bad practice

class Foo
  def bar
    puts baz
  end
end

module Foo
  def bar
    puts baz
  end
end

def foo.bar
  puts baz
end

Recommended

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