summaryrefslogtreecommitdiff
path: root/lisp/time.el
diff options
context:
space:
mode:
authorLars Ingebrigtsen <larsi@gnus.org>2016-04-30 22:41:41 +0200
committerLars Ingebrigtsen <larsi@gnus.org>2016-04-30 22:41:41 +0200
commit45559c584e5a4ddeed1539b028b50b95baa372f8 (patch)
tree76a5d59c2d9221eee52189a05de23deea4cf8d16 /lisp/time.el
parentbcf0291d0cd02095b0809b1eb91f1e5c5c2ac5e3 (diff)
downloademacs-45559c584e5a4ddeed1539b028b50b95baa372f8.tar.gz
Add a doc string to display-time-string
* lisp/time.el: Add a doc string to `display-time-string', because it's referred to in the manual, and is too mysterious otherwise (bug#21002).
Diffstat (limited to 'lisp/time.el')
-rw-r--r--lisp/time.el5
1 files changed, 4 insertions, 1 deletions
diff --git a/lisp/time.el b/lisp/time.el
index e0d39b19586..ba5792441c4 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