Adds some random docs #693

Merged
merged 1 commit into from Jan 4, 2013
View
11 lib/jekyll/filters.rb
@@ -57,6 +57,17 @@ def date_to_xmlschema(date)
date.xmlschema
end
+ # XML escape a string for use. Replaces any special characters with
+ # appropriate HTML entity replacements.
+ #
+ # input - The String to escape.
+ #
+ # Examples
+ #
+ # xml_escape('foo "bar" <baz>')
+ # # => "foo &quot;bar&quot; &lt;baz&gt;"
+ #
+ # Returns the escaped String.
def xml_escape(input)
CGI.escapeHTML(input)
end
View
9 lib/jekyll/post.rb
@@ -44,8 +44,8 @@ def initialize(site, source, dir, name)
raise FatalException.new("#{msg} in #{@base}/#{name}")
end
- #If we've added a date and time to the yaml, use that instead of the filename date
- #Means we'll sort correctly.
+ # If we've added a date and time to the yaml, use that instead of the
+ # filename date Means we'll sort correctly.
@mojombo
mojombo Dec 21, 2012

There's a missing period here after "date".

if self.data.has_key?('date')
# ensure Time via to_s and reparse
self.date = Time.parse(self.data["date"].to_s)
@@ -64,7 +64,10 @@ def initialize(site, source, dir, name)
end
end
- # Spaceship is based on Post#date, slug
+ # Compares Post objects. First compares the Post date. If the dates are
+ # equal, it compares the Post slugs.
+ #
+ # +other+ is the object we are comparing to.
@mojombo
mojombo Dec 21, 2012

Could you do this in TomDoc style? I'd love to have everything converted to that in the long run.

#
# Returns -1, 0, 1
def <=>(other)