diff options
| author | Eli Zaretskii | 2015-09-20 09:34:24 +0300 |
|---|---|---|
| committer | Eli Zaretskii | 2015-09-20 09:34:24 +0300 |
| commit | 00a65e3238a888fc92b0c2aab8cb5bda8bd99c29 (patch) | |
| tree | 4a2b41d1545c5049a9630ab48333fac73b8e4eb2 | |
| parent | 404f3aff4f709641b45e5bcd61f91f860426e0cf (diff) | |
| download | emacs-00a65e3238a888fc92b0c2aab8cb5bda8bd99c29.tar.gz emacs-00a65e3238a888fc92b0c2aab8cb5bda8bd99c29.zip | |
Improve documentation of 'run-at-time'
* lisp/emacs-lisp/timer.el (run-at-time): Improve the doc string.
In particular, don't refer to 'diary-entry-time', because it is
unavailable until diary-lib is loaded. Also, refer to
'timer-duration-words', not 'timer-duration', as the latter's doc
string says nothing about the accepted strings.
| -rw-r--r-- | lisp/emacs-lisp/timer.el | 21 |
1 files changed, 11 insertions, 10 deletions
diff --git a/lisp/emacs-lisp/timer.el b/lisp/emacs-lisp/timer.el index c80c49630ec..2aca26cf166 100644 --- a/lisp/emacs-lisp/timer.el +++ b/lisp/emacs-lisp/timer.el | |||
| @@ -345,22 +345,23 @@ 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 | REPEAT may be an integer or floating point number. | ||
| 348 | TIME should be one of: | 349 | TIME should be one of: |
| 349 | - a string giving an absolute time like \"11:23pm\" (the | 350 | - a string giving today's time like \"11:23pm\" |
| 350 | acceptable formats are those recognized by | 351 | (the acceptable formats are HHMM, H:MM, HH:MM, HHam, HHAM, |
| 351 | `diary-entry-time'; note that such times are interpreted | 352 | HHpm, HHPM, HH:MMam, HH:MMAM, HH:MMpm, or HH:MMPM; |
| 352 | as times today, even if in the past); | 353 | a period '.' can be used instead of a colon ':' to separate |
| 353 | - a string giving a relative time like \"2 hours 35 minutes\" | 354 | the hour and minute parts); |
| 354 | (the acceptable formats are those recognized by | 355 | - a string giving a relative time like \"90\" or \"2 hours 35 minutes\" |
| 355 | `timer-duration'); | 356 | (the acceptable forms are a number of seconds without units |
| 356 | - nil meaning now; | 357 | or some combination of values using units in `timer-duration-words'); |
| 358 | - nil, meaning now; | ||
| 357 | - a number of seconds from now; | 359 | - a number of seconds from now; |
| 358 | - a value from `encode-time'; | 360 | - a value from `encode-time'; |
| 359 | - or t (with non-nil REPEAT) meaning the next integral | 361 | - or t (with non-nil REPEAT) meaning the next integral |
| 360 | multiple of REPEAT. | 362 | multiple of REPEAT. |
| 361 | 363 | ||
| 362 | REPEAT may be an integer or floating point number. The | 364 | The action is to call FUNCTION with arguments ARGS. |
| 363 | action is to call FUNCTION with arguments ARGS. | ||
| 364 | 365 | ||
| 365 | This function returns a timer object which you can use in | 366 | This function returns a timer object which you can use in |
| 366 | `cancel-timer'." | 367 | `cancel-timer'." |