NAME has it right:
        ... – execute a function after a specified period of time

but DESCRIPTION says something else:
        The timeout API provides a mechanism to execute a function
        at a given time.

The latter reads as if I could pass a specific point in time, e.g.
Fri Jul 22 16:00:00 UTC 2022, at which a function should be run.

But this API is about timeouts, i.e. a duration of time like 10s,
which does not my understanding of "at a given time".


So reuse NAME's wording and make it a proper sentence.

Feedback? OK?

Index: timeout.9
===================================================================
RCS file: /cvs/src/share/man/man9/timeout.9,v
retrieving revision 1.55
diff -u -p -r1.55 timeout.9
--- timeout.9   22 Jun 2022 14:10:49 -0000      1.55
+++ timeout.9   22 Jul 2022 10:41:54 -0000
@@ -88,7 +88,8 @@
 .Sh DESCRIPTION
 The
 .Nm timeout
-API provides a mechanism to execute a function at a given time.
+API provides a mechanism to execute a function after a specified period of
+time has elapsed.
 The granularity of the time is limited by the granularity of the
 .Xr hardclock 9
 timer which executes

Reply via email to