]> code.delx.au - gnu-emacs/commitdiff
* lisp/emacs-lisp/timer.el (run-at-time): Docstring formatting
authorArtur Malabarba <bruce.connor.am@gmail.com>
Sat, 19 Sep 2015 20:39:09 +0000 (21:39 +0100)
committerArtur Malabarba <bruce.connor.am@gmail.com>
Sat, 19 Sep 2015 20:39:09 +0000 (21:39 +0100)
lisp/emacs-lisp/timer.el

index bf8e9ff273a36831013d70b34ac43ce69e6ba3c8..c80c49630ec257e843ef78005ea505a66955dd82 100644 (file)
@@ -345,18 +345,25 @@ This function is called, by name, directly by the C code."
 (defun run-at-time (time repeat function &rest args)
   "Perform an action at time TIME.
 Repeat the action every REPEAT seconds, if REPEAT is non-nil.
-TIME should be one of: a string giving an absolute time like
-\"11:23pm\" (the acceptable formats are those recognized by
-`diary-entry-time'; note that such times are interpreted as times
-today, even if in the past); a string giving a relative time like
-\"2 hours 35 minutes\" (the acceptable formats are those
-recognized by `timer-duration'); nil meaning now; a number of
-seconds from now; a value from `encode-time'; or t (with non-nil
-REPEAT) meaning the next integral multiple of REPEAT.  REPEAT may
-be an integer or floating point number.  The action is to call
-FUNCTION with arguments ARGS.
-
-This function returns a timer object which you can use in `cancel-timer'."
+TIME should be one of:
+- a string giving an absolute time like \"11:23pm\" (the
+  acceptable formats are those recognized by
+  `diary-entry-time'; note that such times are interpreted
+  as times today, even if in the past);
+- a string giving a relative time like \"2 hours 35 minutes\"
+  (the acceptable formats are those recognized by
+  `timer-duration');
+- nil meaning now;
+- a number of seconds from now;
+- a value from `encode-time';
+- or t (with non-nil REPEAT) meaning the next integral
+  multiple of REPEAT.
+
+REPEAT may be an integer or floating point number.  The
+action is to call FUNCTION with arguments ARGS.
+
+This function returns a timer object which you can use in
+`cancel-timer'."
   (interactive "sRun at time: \nNRepeat interval: \naFunction: ")
 
   (or (null repeat)