diff options
| author | Artur Malabarba | 2015-09-19 21:39:09 +0100 |
|---|---|---|
| committer | Artur Malabarba | 2015-09-19 21:39:09 +0100 |
| commit | df6f6107257cb76d994fff97fc8904a3d1bd3fb4 (patch) | |
| tree | e5c4c137b9420685954b3c01db4f69dbafc7ba59 /lisp | |
| parent | 2ebcda4da0683f0c9102779bde13843795d6db78 (diff) | |
| download | emacs-df6f6107257cb76d994fff97fc8904a3d1bd3fb4.tar.gz emacs-df6f6107257cb76d994fff97fc8904a3d1bd3fb4.zip | |
* lisp/emacs-lisp/timer.el (run-at-time): Docstring formatting
Diffstat (limited to 'lisp')
| -rw-r--r-- | lisp/emacs-lisp/timer.el | 31 |
1 files 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." | |||
| 345 | (defun run-at-time (time repeat function &rest args) | 345 | (defun run-at-time (time repeat function &rest args) |
| 346 | "Perform an action at time TIME. | 346 | "Perform an action at time TIME. |
| 347 | Repeat the action every REPEAT seconds, if REPEAT is non-nil. | 347 | Repeat the action every REPEAT seconds, if REPEAT is non-nil. |
| 348 | TIME should be one of: a string giving an absolute time like | 348 | TIME should be one of: |
| 349 | \"11:23pm\" (the acceptable formats are those recognized by | 349 | - a string giving an absolute time like \"11:23pm\" (the |
| 350 | `diary-entry-time'; note that such times are interpreted as times | 350 | acceptable formats are those recognized by |
| 351 | today, even if in the past); a string giving a relative time like | 351 | `diary-entry-time'; note that such times are interpreted |
| 352 | \"2 hours 35 minutes\" (the acceptable formats are those | 352 | as times today, even if in the past); |
| 353 | recognized by `timer-duration'); nil meaning now; a number of | 353 | - a string giving a relative time like \"2 hours 35 minutes\" |
| 354 | seconds from now; a value from `encode-time'; or t (with non-nil | 354 | (the acceptable formats are those recognized by |
| 355 | REPEAT) meaning the next integral multiple of REPEAT. REPEAT may | 355 | `timer-duration'); |
| 356 | be an integer or floating point number. The action is to call | 356 | - nil meaning now; |
| 357 | FUNCTION with arguments ARGS. | 357 | - a number of seconds from now; |
| 358 | 358 | - a value from `encode-time'; | |
| 359 | This function returns a timer object which you can use in `cancel-timer'." | 359 | - or t (with non-nil REPEAT) meaning the next integral |
| 360 | multiple of REPEAT. | ||
| 361 | |||
| 362 | REPEAT may be an integer or floating point number. The | ||
| 363 | action is to call FUNCTION with arguments ARGS. | ||
| 364 | |||
| 365 | This function returns a timer object which you can use in | ||
| 366 | `cancel-timer'." | ||
| 360 | (interactive "sRun at time: \nNRepeat interval: \naFunction: ") | 367 | (interactive "sRun at time: \nNRepeat interval: \naFunction: ") |
| 361 | 368 | ||
| 362 | (or (null repeat) | 369 | (or (null repeat) |