]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Revise the description of time.clock() so that it correctly describes the
authorFred Drake <fdrake@acm.org>
Mon, 16 Jul 2001 15:41:38 +0000 (15:41 +0000)
committerFred Drake <fdrake@acm.org>
Mon, 16 Jul 2001 15:41:38 +0000 (15:41 +0000)
Windows version of the function as well as the Unix flavor.

This fixes SF bug #441357.

Doc/lib/libtime.tex

index 30cae459dad349fb66d5656b22582c41307ebf5f..f8d5df2d18658e6d95906a48701c52e435008556 100644 (file)
@@ -126,11 +126,18 @@ the C function of the same name, there is no trailing newline.
 \end{funcdesc}
 
 \begin{funcdesc}{clock}{}
-Return the current CPU 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 ``CPU time''\index{CPU 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}}