aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorStefan Kangas2022-08-13 20:30:12 +0200
committerStefan Kangas2022-08-13 20:30:12 +0200
commit0a9375938529c7603f19204cd166716f63e8a640 (patch)
tree3f1d3e43e6a37c84878b49222aae88aad7748ce7 /src
parentdd2973bf5040d26d29a937d252eeaf2884dca9fb (diff)
downloademacs-0a9375938529c7603f19204cd166716f63e8a640.tar.gz
emacs-0a9375938529c7603f19204cd166716f63e8a640.zip
Improve time-convert docstring formatting for readability
* src/timefns.c (Ftime_convert): Doc fix; improve formatting for readability.
Diffstat (limited to 'src')
-rw-r--r--src/timefns.c18
1 files changed, 12 insertions, 6 deletions
diff --git a/src/timefns.c b/src/timefns.c
index 1112f174763..8b1e729d4f4 100644
--- a/src/timefns.c
+++ b/src/timefns.c
@@ -1719,14 +1719,20 @@ With optional FORM, convert to that timestamp form.
1719Truncate the returned value toward minus infinity. 1719Truncate the returned value toward minus infinity.
1720 1720
1721If FORM is nil (the default), return the same form as `current-time'. 1721If FORM is nil (the default), return the same form as `current-time'.
1722
1722If FORM is a positive integer, return a pair of integers (TICKS . FORM), 1723If FORM is a positive integer, return a pair of integers (TICKS . FORM),
1723where TICKS is the number of clock ticks and FORM is the clock frequency 1724where TICKS is the number of clock ticks and FORM is the clock frequency
1724in ticks per second. If FORM is t, return (TICKS . PHZ), where 1725in ticks per second.
1725PHZ is a suitable clock frequency in ticks per second. If FORM is 1726
1726`integer', return an integer count of seconds. If FORM is `list', 1727If FORM is t, return (TICKS . PHZ), where PHZ is a suitable clock
1727return an integer list (HIGH LOW USEC PSEC), where HIGH has the most 1728frequency in ticks per second.
1728significant bits of the seconds, LOW has the least significant 16 1729
1729bits, and USEC and PSEC are the microsecond and picosecond counts. */) 1730If FORM is `integer', return an integer count of seconds.
1731
1732If FORM is `list', return an integer list (HIGH LOW USEC PSEC), where
1733HIGH has the most significant bits of the seconds, LOW has the least
1734significant 16 bits, and USEC and PSEC are the microsecond and
1735picosecond counts. */)
1730 (Lisp_Object time, Lisp_Object form) 1736 (Lisp_Object time, Lisp_Object form)
1731{ 1737{
1732 struct lisp_time t; 1738 struct lisp_time t;