From: Fred Drake <fdrake@acm.org>
Date: Mon, 16 Jul 2001 15:41:38 +0000 (+0000)
Subject: Revise the description of time.clock() so that it correctly describes the
X-Git-Tag: v2.1.1~30
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c743869a59972f4accc0c1f6ab9594ef888e0f20;p=thirdparty%2FPython%2Fcpython.git

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.
---

diff --git a/Doc/lib/libtime.tex b/Doc/lib/libtime.tex
index 30cae459dad3..f8d5df2d1865 100644
--- a/Doc/lib/libtime.tex
+++ b/Doc/lib/libtime.tex
@@ -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}}