Ticket #3311: naturalday_docs_v3.diff

add_ons.txt

@@ -130 +130 @@
-
-You can pass in either an integer or a string representation of an integer.
-
+naturalday
+----------
+
+Converts a date to natural string, if it's today, tomorrow or yesterday
+
+**Argument:** Date formatting string as described in default tag now_.
+
+.. _now: ../templates/#now
+
+Examples (when 'today' is 17 Feb 2007):
+
+    * ``16 Feb 2007`` becomes ``yesterday``.
+    * ``17 Feb 2007`` becomes ``today``.
+    * ``18 Feb 2007`` becomes ``tomorrow``.
+    * Any other day is formatted according to given argument or `DATE_FORMAT`_ if
+      argument is not given.
+
+.. _DATE_FORMAT: ../settings/#date_format
+
-flatpages
-=========
-