]> git.eshelyaron.com Git - emacs.git/commitdiff
Improve time-convert docstring formatting for readability
authorStefan Kangas <stefan@marxist.se>
Sat, 13 Aug 2022 18:30:12 +0000 (20:30 +0200)
committerStefan Kangas <stefan@marxist.se>
Sat, 13 Aug 2022 18:30:12 +0000 (20:30 +0200)
* src/timefns.c (Ftime_convert): Doc fix; improve formatting for
readability.

src/timefns.c

index 1112f1747635e106337361e017ae58112495b4a9..8b1e729d4f4aa411c3d957ddc71334a9d9c20d0d 100644 (file)
@@ -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;