Improve documentation of functions that accept time values
commit36bafc9cee918e88f9f62dd8ac2a1a0f6495c0b1
authorEli Zaretskii <eliz@gnu.org>
Fri, 18 Nov 2016 11:02:34 +0000 (18 13:02 +0200)
committerEli Zaretskii <eliz@gnu.org>
Fri, 18 Nov 2016 11:02:34 +0000 (18 13:02 +0200)
treec4a455ec95b95c2a2bd2912fc3839ac812921ab1
parenta37c08d524db722063111329458dc8f4368c46a2
Improve documentation of functions that accept time values

* doc/lispref/os.texi (Time Calculations): Mention the meaning of
'nil' or a scalar number as the time-value argument.  Add a
cross-reference to 'float-time' for computing a time difference as
a scalar number of seconds.

* src/editfns.c (Fformat_time_string, Ftime_less_p)
(Ftime_subtract, Ftime_add, Fdecode_time, Fcurrent_time_string)
(Fcurrent_time_zone): Mention in the doc strings the meaning of
nil argument and the fact that a time value can be a scalar number
of seconds since the epoch.
(Ftime_subtract): Mention 'float-time'.
doc/lispref/os.texi
src/editfns.c