Add missing doc for TiFighter.relatizeDate

marchon · Feb 28, 2011 · 1a9e20b · 1a9e20b
1 parent c586b20
commit 1a9e20b
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/ti-fighter.js b/ti-fighter.js
@@ -449,6 +449,12 @@ var TiFighter = (function(window) {
 
   // --------------------------------------------------------------------
 
+  /**
+   * Converts a date into a "relative" notation. Eg: 1 hour ago, 2 days ago, about
+   * 5 minutes ago.  Based on GitHub's jQuery Relatize Date
+   * (https://github.com/github/jquery-relatize_date).
+   */
+
   TiFighter.relatizeDate = function(date, includeTime) {
     function distanceOfTimeInWords(fromTime, toTime, includeTime) {