From df6f6107257cb76d994fff97fc8904a3d1bd3fb4 Mon Sep 17 00:00:00 2001 From: Artur Malabarba Date: Sat, 19 Sep 2015 21:39:09 +0100 Subject: [PATCH] * lisp/emacs-lisp/timer.el (run-at-time): Docstring formatting --- lisp/emacs-lisp/timer.el | 31 +++++++++++++++++++------------ 1 file changed, 19 insertions(+), 12 deletions(-) diff --git a/lisp/emacs-lisp/timer.el b/lisp/emacs-lisp/timer.el index bf8e9ff273a..c80c49630ec 100644 --- a/lisp/emacs-lisp/timer.el +++ b/lisp/emacs-lisp/timer.el @@ -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) -- 2.39.2