Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds some random docs #693

Merged
merged 1 commit into from Jan 4, 2013
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 11 additions & 0 deletions lib/jekyll/filters.rb
Expand Up @@ -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
Expand Down
9 changes: 6 additions & 3 deletions lib/jekyll/post.rb
Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)
Expand All @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)
Expand Down