mirror/emacs
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2025-02-07 20:54:32 +00:00
Code Issues Releases Activity

* lisp/emacs-lisp/timer.el (run-at-time): Docstring formatting

Browse Source
This commit is contained in:
Artur Malabarba 2015-09-19 21:39:09 +01:00
parent 2ebcda4da0
commit df6f610725
1 changed files with 18 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
lisp/emacs-lisp/timer.el
View 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.
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.
This function returns a timer object which you can use in `cancel-timer'."
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)