summaryrefslogtreecommitdiffstats
path: root/Doc/lib
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2001-07-16 15:40:57 (GMT)
committerFred Drake <fdrake@acm.org>2001-07-16 15:40:57 (GMT)
commit687a17deaacdde85b7a9f33d36cc1eea9c868039 (patch)
treef254e98e84c2e7afb6b628b0c00e15c65161a2a7 /Doc/lib
parent63a47402b354e76255d4a629ee3e1950d843af25 (diff)
downloadcpython-687a17deaacdde85b7a9f33d36cc1eea9c868039.zip
cpython-687a17deaacdde85b7a9f33d36cc1eea9c868039.tar.gz
cpython-687a17deaacdde85b7a9f33d36cc1eea9c868039.tar.bz2
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.
Diffstat (limited to 'Doc/lib')
-rw-r--r--Doc/lib/libtime.tex16
1 files changed, 11 insertions, 5 deletions
diff --git a/Doc/lib/libtime.tex b/Doc/lib/libtime.tex
index 82953db..6823d5f 100644
--- a/Doc/lib/libtime.tex
+++ b/Doc/lib/libtime.tex
@@ -126,12 +126,18 @@ the C function of the same name, there is no trailing newline.
\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}}