aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorBasil L. Contovounesios2022-08-13 21:59:39 +0300
committerBasil L. Contovounesios2022-08-13 21:59:39 +0300
commit864847bf3c9f041256e32353b323ddafee86f6da (patch)
tree415aed4316b7a9c7951a0fbc52a6a82323406d7c /src
parent0a9375938529c7603f19204cd166716f63e8a640 (diff)
downloademacs-864847bf3c9f041256e32353b323ddafee86f6da.tar.gz
emacs-864847bf3c9f041256e32353b323ddafee86f6da.zip
Document time-convert FORM argument as mandatory
This is a followup to commit b70369c557 of 2022-08-05 "time-convert): Deprecate calls without an explicit FORM arg". * doc/lispref/os.texi (Time Conversion): * src/timefns.c (Ftime_convert): Describe FORM argument as required as per the advertised calling convention.
Diffstat (limited to 'src')
-rw-r--r--src/timefns.c5
1 files changed, 2 insertions, 3 deletions
diff --git a/src/timefns.c b/src/timefns.c
index 8b1e729d4f4..7db50ea81cc 100644
--- a/src/timefns.c
+++ b/src/timefns.c
@@ -1714,11 +1714,10 @@ usage: (encode-time TIME &rest OBSOLESCENT-ARGUMENTS) */)
1714} 1714}
1715 1715
1716DEFUN ("time-convert", Ftime_convert, Stime_convert, 1, 2, 0, 1716DEFUN ("time-convert", Ftime_convert, Stime_convert, 1, 2, 0,
1717 doc: /* Convert TIME value to a Lisp timestamp. 1717 doc: /* Convert TIME value to a Lisp timestamp of the given FORM.
1718With optional FORM, convert to that timestamp form.
1719Truncate the returned value toward minus infinity. 1718Truncate the returned value toward minus infinity.
1720 1719
1721If FORM is nil (the default), return the same form as `current-time'. 1720If FORM is nil, return the same form as `current-time'.
1722 1721
1723If FORM is a positive integer, return a pair of integers (TICKS . FORM), 1722If FORM is a positive integer, return a pair of integers (TICKS . FORM),
1724where TICKS is the number of clock ticks and FORM is the clock frequency 1723where TICKS is the number of clock ticks and FORM is the clock frequency