diff Doc/lib/libtime.tex @ 18623:35fec487bcef legacy-trunk

Revise the description of time.clock() so that it correctly describes the Windows version of the function as well as the Unix flavor. This fixes SF bug #441357.
author Fred Drake <fdrake@acm.org>
date Mon, 16 Jul 2001 15:40:57 +0000
parents 346dcafc878b
children c942a9821d09
line wrap: on
line diff
--- a/Doc/lib/libtime.tex	Mon Jul 16 14:46:13 2001 +0000
+++ b/Doc/lib/libtime.tex	Mon Jul 16 15:40:57 2001 +0000
@@ -126,12 +126,18 @@
 \end{funcdesc}
 
 \begin{funcdesc}{clock}{}
-Return the current processor time as a floating point number expressed in
+On \UNIX, return
+the current processor time as a floating point number expressed in
 seconds.  The precision, and in fact the very definition of the meaning
-of ``processor time''\index{CPU time}\index{processor time}, depends on
-that of the C function of the same name, but in any case, this is the
-function to use for benchmarking\index{benchmarking} Python or timing
-algorithms.
+of ``processor time''\index{CPU time}\index{processor time}, depends
+on that of the C function of the same name, but in any case, this is
+the function to use for benchmarking\index{benchmarking} Python or
+timing algorithms.
+
+On Windows, this function returns the nearest approximation to
+wall-clock time since the first call to this function, based on the
+Win32 function \cfunction{QueryPerformanceCounter()}.  The resolution
+is typically better than one microsecond.
 \end{funcdesc}
 
 \begin{funcdesc}{ctime}{\optional{secs}}