redrug 0.2 → 0.2.1

data/lib/red_rug.rb

@@ -1,13 +1,60 @@
 require 'redcarpet'
 
+=begin rdoc
+
+RedRug provides a simplified interface to the functionality of the Redcarpet
+gem for Markdown handling, intended to provide convenience in execution of
+common tasks.  At present, only HTML output is supported.
+
+=end
+
 module RedRug
-  def self.version; '0.2'; end
+
+=begin rdoc
+
+This method returns the version number of the RedRug gem.
+
+=end
+
+  def self.version; '0.2.1'; end
+
+=begin rdoc
+
+The +markdown_string+ argument is a string containing text using Markdown
+formatting recognized by Redcarpet.  The method returns an HTML formatted
+version of the string.  It depends on the Redcarpet implementation, which adds
+a newline at the end of the output string.
+
+Example:
+
+        RedRug.to_html('#foo')
+        => "<h1>foo</h1>\n"
+
+=end
 
   def self.to_html(markdown_string)
     markdown = Redcarpet::Markdown.new(Redcarpet::Render::HTML)
     markdown.render(markdown_string)
   end
 
+=begin rdoc
+
+The +filename+ argument is a string consisting of the name of a file, including
+path information as necessary.
+
+The +output_format+ argument is an output format supported by RedRug via +to_*+
+methods, indicated in lower case letters.  When no +output_format+ is
+specified, it defaults to HTML.
+
+Example, assuming a file +file.md+ containing only +#foo+ on the first line:
+
+        RedRug.from_file('/usr/home/username/file.md', 'html')
+        => "<h1>foo</h1>\n"
+
+It depends on the implementation of the +to_*+ method it calls.
+
+=end
+
   def self.from_file(filename, output_format='html')
     case output_format
     when 'html'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redrug
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &20891740 !ruby/object:Gem::Requirement
+  requirement: &5824980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *20891740
+  version_requirements: *5824980
 description: ! "    RedRug is a wrapper for Redcarpet, intended to provide more convenient\n
   \   interfaces for common Markdown parsing use cases.\n"
 email: code@apotheon.net