[Emacs-diffs] emacs-25 ecdb340 50/64: Add a doc string to display-time-string

[Lars Ingebrigtsen]

branch: emacs-25
commit ecdb340c2d306de173169d172b9641696dd7ac34
Author: Lars Ingebrigtsen <address@hidden>
Commit: Lars Ingebrigtsen <address@hidden>

    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).
    
    (cherry picked from commit 45559c584e5a4ddeed1539b028b50b95baa372f8)
---
 lisp/time.el |    5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/lisp/time.el b/lisp/time.el
index e0d39b1..ba57924 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