time.el minor doc fixes.

* lisp/time.el (display-time-load-average, display-time-next-load-average):
Doc fixes.

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 8f333945de35e6c1ccc1e5af96b2dc6b3cf65212..8ec5f49e63443bfbdf3876504043ee34571237cc 100644 (file)
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,5 +1,8 @@
 2012-01-06  Glenn Morris  <rgm@gnu.org>
 
+       * time.el (display-time-load-average, display-time-next-load-average):
+       Doc fixes.
+
        * emacs-lisp/bytecomp.el (byte-compile-file): Do not propagate a file
        local setting of buffer-read-only to the input buffer.  (Bug#10419)
 

diff --git a/lisp/time.el b/lisp/time.el
index f7d1490a6c471c9000c2de4837ea3330c6e8c2fd..f611aa175435ee25647f75a91a1a3560140f04a4 100644 (file)
--- a/lisp/time.el
+++ b/lisp/time.el
@@ -78,7 +78,8 @@ The value can be one of:
   :group 'display-time)
 
 (defvar display-time-load-average nil
-  "Load average currently being shown in mode line.")
+  "Load average currently being shown in mode line.
+See `display-time-default-load-average'.")
 
 (defcustom display-time-load-average-threshold 0.1
   "Load-average values below this value won't be shown in the mode line."
@@ -349,6 +350,8 @@ would give mode line times like `94/12/30 21:07:48 (UTC)'."
          (timer-activate timer)))))
 
 (defun display-time-next-load-average ()
+  "Switch between different load averages in the mode line.
+Switches from the 1 to 5 to 15 minute load average, and then back to 1."
   (interactive)
   (if (= 3 (setq display-time-load-average (1+ display-time-load-average)))
       (setq display-time-load-average 0))