; Improve commentary in calendar.el

* lisp/calendar/calendar.el: Expand the commentary.  Suggested by
Richard Lawrence <rwl@recursewithless.net>.  (Bug#74965)

diff --git a/lisp/calendar/calendar.el b/lisp/calendar/calendar.el
index f5066c61ae28c8b7b9bc3c83be0614188670973a..a2382f3dd1a78cbd2eabd28b43431230258b9aaa 100644 (file)
--- a/lisp/calendar/calendar.el
+++ b/lisp/calendar/calendar.el
@@ -96,10 +96,13 @@
 ;; list of integers (MONTH DAY YEAR) -- see the functions
 ;; `calendar-extract-year', `calendar-extract-month', and
 ;; `calendar-extract-day'.  Internally it also uses an "absolute" format
-;; which is an integer number of days since December 31, 1BC (see
-;; e.g. `calendar-absolute-from-gregorian'), and converts between
-;; different calendar scales by converting to and from the absolute
-;; format (see e.g. `calendar-iso-from-absolute' in cal-iso.el).
+;; which is an integer number of days since December 31, 1BC on the
+;; Gregorian calendar (see e.g. `calendar-absolute-from-gregorian'), and
+;; converts between different calendar scales by converting to and from
+;; the absolute format (see e.g. `calendar-iso-from-absolute' in
+;; cal-iso.el).  This representation is also useful for certain
+;; calculations; e.g. `calendar-day-of-week' is simply the absolute
+;; represention modulo 7, because December 31, 1BC is a Sunday.
 
 ;; A note on free variables: