summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--lisp/time.el5
1 files changed, 4 insertions, 1 deletions
diff --git a/lisp/time.el b/lisp/time.el
index e0d39b1958..ba5792441c 100644
--- a/lisp/time.el
+++ b/lisp/time.el
@@ -108,7 +108,10 @@ A value of nil means 1 <= hh <= 12, and an AM/PM suffix is used."
:type 'boolean
:group 'display-time)
-(defvar display-time-string nil)
+(defvar display-time-string nil
+ "String used in mode lines to display a time string.
+It should not be set directly, but is instead updated by the
+`display-time' function.")
;;;###autoload(put 'display-time-string 'risky-local-variable t)
(defcustom display-time-hook nil