diff options
| author | Lars Ingebrigtsen <larsi@gnus.org> | 2016-04-30 22:41:41 +0200 |
|---|---|---|
| committer | Lars Ingebrigtsen <larsi@gnus.org> | 2016-04-30 22:41:41 +0200 |
| commit | 45559c584e5a4ddeed1539b028b50b95baa372f8 (patch) | |
| tree | 76a5d59c2d9221eee52189a05de23deea4cf8d16 | |
| parent | bcf0291d0cd02095b0809b1eb91f1e5c5c2ac5e3 (diff) | |
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).
| -rw-r--r-- | lisp/time.el | 5 |
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 |