From: Lars Ingebrigtsen <larsi@gnus.org>
Date: Sat, 30 Apr 2016 20:41:41 +0000 (+0200)
Subject: Add a doc string to display-time-string
X-Git-Tag: emacs-26.0.90~2058
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=45559c584e5a4ddeed1539b028b50b95baa372f8;p=emacs.git

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).
---

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