summaryrefslogtreecommitdiff
path: root/lisp/emacs-lisp/timer.el
diff options
context:
space:
mode:
authorStefan Kangas <stefan@marxist.se>2021-09-27 23:56:55 +0200
committerStefan Kangas <stefan@marxist.se>2021-10-05 02:06:57 +0200
commit0a7bab689c4a113dd295c9db55d8e76a34d5f9e1 (patch)
tree48b28bc4a1a8b261b46dd419a060ddb09fca6274 /lisp/emacs-lisp/timer.el
parente2861e2d08afd5dba9f676aa1e1d151a4d7dbc8f (diff)
downloademacs-0a7bab689c4a113dd295c9db55d8e76a34d5f9e1.tar.gz
emacs-0a7bab689c4a113dd295c9db55d8e76a34d5f9e1.tar.bz2
emacs-0a7bab689c4a113dd295c9db55d8e76a34d5f9e1.zip
; Minor stylistic fixes found by checkdoc
Diffstat (limited to 'lisp/emacs-lisp/timer.el')
-rw-r--r--lisp/emacs-lisp/timer.el19
1 files changed, 13 insertions, 6 deletions
diff --git a/lisp/emacs-lisp/timer.el b/lisp/emacs-lisp/timer.el
index 382f6bb1fa3..1ef4931b7be 100644
--- a/lisp/emacs-lisp/timer.el
+++ b/lisp/emacs-lisp/timer.el
@@ -125,9 +125,12 @@ of SECS seconds since the epoch. SECS may be a fraction."
(time-convert (cons (- more-ticks (% more-ticks trunc-s-ticks)) hz)))))
(defun timer-relative-time (time secs &optional usecs psecs)
- "Advance TIME by SECS seconds and optionally USECS microseconds
-and PSECS picoseconds. SECS may be either an integer or a
-floating point number."
+ "Advance TIME by SECS seconds.
+
+Optionally also advance it by USECS microseconds and PSECS
+picoseconds.
+
+SECS may be either an integer or a floating point number."
(let ((delta secs))
(if (or usecs psecs)
(setq delta (time-add delta (list 0 0 (or usecs 0) (or psecs 0)))))
@@ -138,9 +141,13 @@ floating point number."
(time-less-p (timer--time t1) (timer--time t2)))
(defun timer-inc-time (timer secs &optional usecs psecs)
- "Increment the time set in TIMER by SECS seconds, USECS microseconds,
-and PSECS picoseconds. SECS may be a fraction. If USECS or PSECS are
-omitted, they are treated as zero."
+ "Increment the time set in TIMER by SECS seconds.
+
+Optionally also increment it by USECS microseconds, and PSECS
+picoseconds. If USECS or PSECS are omitted, they are treated as
+zero.
+
+SECS may be a fraction."
(setf (timer--time timer)
(timer-relative-time (timer--time timer) secs usecs psecs)))