procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve time-convert docstring formatting for readability

Browse source 
* src/timefns.c (Ftime_convert): Doc fix; improve formatting for
readability.
This commit is contained in:
Stefan Kangas 2022-08-13 20:30:12 +02:00
parent dd2973bf50
commit 0a93759385
1 changed files with 12 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
src/timefns.c
View 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;