Documentation for HTTP.rfc1123_date. (#4418)

crystal-lang · May 18, 2017 · d62caee · d62caee
1 parent 3c1678e
commit d62caee
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/http/common.cr b/src/http/common.cr
@@ -224,6 +224,11 @@ module HTTP
     nil
   end
 
+  # Format a Time object as a String using the format specified by [RFC 1123](https://tools.ietf.org/html/rfc1123#page-55).
+  #
+  # ```
+  # HTTP.rfc1123_date(Time.new(2016, 2, 15)) # => "Sun, 14 Feb 2016 21:00:00 GMT"
+  # ```
   def self.rfc1123_date(time : Time) : String
     # TODO: GMT should come from the Time classes instead
     time.to_utc.to_s("%a, %d %b %Y %H:%M:%S GMT")