Skip to content

Instantly share code, notes, and snippets.

@mbleigh
Created February 6, 2012 20:12
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save mbleigh/1754526 to your computer and use it in GitHub Desktop.
Save mbleigh/1754526 to your computer and use it in GitHub Desktop.
MyClass
This class is a simple class that does things. Notice that I'm
just using it as an example for potential documentation style.
.class_method
Does something at the class level.
@param options [Hash] A hash of options
.new
Creates a new instance of MyClass
#method_one?
This method does something.
@return [Boolean] Whether or not this evaluated to true.
class MyClass
def self.class_method(options = {})
# ...
end
def initializer(arg1, arg2)
# ...
end
def method_one?
# ...
end
end
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment