[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
master 0a93759385: Improve time-convert docstring formatting for readabi
From: |
Stefan Kangas |
Subject: |
master 0a93759385: Improve time-convert docstring formatting for readability |
Date: |
Sat, 13 Aug 2022 14:30:20 -0400 (EDT) |
branch: master
commit 0a9375938529c7603f19204cd166716f63e8a640
Author: Stefan Kangas <stefan@marxist.se>
Commit: Stefan Kangas <stefan@marxist.se>
Improve time-convert docstring formatting for readability
* src/timefns.c (Ftime_convert): Doc fix; improve formatting for
readability.
---
src/timefns.c | 18 ++++++++++++------
1 file changed, 12 insertions(+), 6 deletions(-)
diff --git a/src/timefns.c b/src/timefns.c
index 1112f17476..8b1e729d4f 100644
--- a/src/timefns.c
+++ b/src/timefns.c
@@ -1719,14 +1719,20 @@ With optional FORM, convert to that timestamp form.
Truncate the returned value toward minus infinity.
If FORM is nil (the default), return the same form as `current-time'.
+
If FORM is a positive integer, return a pair of integers (TICKS . FORM),
where TICKS is the number of clock ticks and FORM is the clock frequency
-in ticks per second. If FORM is t, return (TICKS . PHZ), where
-PHZ is a suitable clock frequency in ticks per second. If FORM is
-`integer', return an integer count of seconds. If FORM is `list',
-return an integer list (HIGH LOW USEC PSEC), where HIGH has the most
-significant bits of the seconds, LOW has the least significant 16
-bits, and USEC and PSEC are the microsecond and picosecond counts. */)
+in ticks per second.
+
+If FORM is t, return (TICKS . PHZ), where PHZ is a suitable clock
+frequency in ticks per second.
+
+If FORM is `integer', return an integer count of seconds.
+
+If FORM is `list', return an integer list (HIGH LOW USEC PSEC), where
+HIGH has the most significant bits of the seconds, LOW has the least
+significant 16 bits, and USEC and PSEC are the microsecond and
+picosecond counts. */)
(Lisp_Object time, Lisp_Object form)
{
struct lisp_time t;
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- master 0a93759385: Improve time-convert docstring formatting for readability,
Stefan Kangas <=