changeset 94456:f990b3871200

(holiday-float): Doc fix.
author Glenn Morris <rgm@gnu.org>
date Tue, 29 Apr 2008 03:35:08 +0000
parents 4c39d8bea007
children 79f15639a32a
files lisp/calendar/holidays.el
diffstat 1 files changed, 7 insertions(+), 9 deletions(-) [+]
line wrap: on
line diff
--- a/lisp/calendar/holidays.el	Tue Apr 29 03:34:40 2008 +0000
+++ b/lisp/calendar/holidays.el	Tue Apr 29 03:35:08 2008 +0000
@@ -689,15 +689,13 @@
         (list (list (list month day y) string)))))
 
 (defun holiday-float (month dayname n string &optional day)
-  "Holiday on MONTH, DAYNAME (Nth occurrence) called STRING.
-If the Nth DAYNAME in MONTH is visible, the value returned is the list
-\(((MONTH DAY year) STRING)).
-
-If N<0, count backward from the end of MONTH.
-
-An optional parameter DAY means the Nth DAYNAME on or after/before MONTH DAY.
-
-Returns nil if it is not visible in the current calendar window."
+  "Holiday called STRING on the Nth DAYNAME after/before MONTH DAY.
+DAYNAME=0 means Sunday, DAYNAME=1 means Monday, and so on.
+If N>0, use the Nth DAYNAME after MONTH DAY.
+If N<0, use the Nth DAYNAME before MONTH DAY.
+DAY defaults to 1 if N>0, and MONTH's last day otherwise.
+If the holiday is visible in the calendar window, returns a
+list (((month day year) STRING)).  Otherwise returns nil."
   ;; This is messy because the holiday may be visible, while the date
   ;; on which it is based is not.  For example, the first Monday after
   ;; December 30 may be visible when January is not.  For large values