Document uri_escape

This commit is contained in:
Mikael Konutgan 2013-05-23 20:18:08 +02:00
parent 008a094e95
commit 9adfd6ddeb
1 changed files with 11 additions and 1 deletions

View File

@ -99,7 +99,17 @@ module Jekyll
def cgi_escape(input)
CGI::escape(input)
end
# URI escape a string.
#
# input - The String to escape.
#
# Examples
#
# uri_escape('foo, bar \\baz?')
# # => "foo,%20bar%20%5Cbaz?"
#
# Returns the escaped String.
def uri_escape(input)
URI.escape(input)
end