[m-rev.] diff: clarify semantics of time__clocks_per_second

[Fergus Henderson]

Estimated hours taken: 0.25
Branches: main, release

library/time.m:
        Add a comment clarifying the semantics of time__clocks_per_second.

Workspace: /home/jupiter/fjh/ws-jupiter2/mercury
Index: library/time.m
===================================================================
RCS file: /home/mercury1/repository/mercury/library/time.m,v
retrieving revision 1.45.2.1
diff -u -d -r1.45.2.1 time.m
--- library/time.m	2 Feb 2005 04:44:42 -0000	1.45.2.1
+++ library/time.m	19 Jun 2005 17:56:56 -0000
@@ -91,6 +91,9 @@
 	%	Returns the number of "clocks" per second as defined by
 	%	CLOCKS_PER_SEC.  A `clock_t' value returned by `time__clock' can
 	%	be divided by this value to obtain a time in seconds.
+	%	Note that the value of this function does not necessarily
+	%	reflect the actual clock precision; it just indicates the
+	%	scaling factor for the results of time__clock.
 	%
 :- func time__clocks_per_sec = int.
 

-- 
Fergus Henderson                    |  "I have always known that the pursuit
                                    |  of excellence is a lethal habit"
WWW: <http://www.cs.mu.oz.au/~fjh>  |     -- the last words of T. S. Garp.
--------------------------------------------------------------------------
mercury-reviews mailing list
post:  mercury-reviews at cs.mu.oz.au
administrative address: owner-mercury-reviews at cs.mu.oz.au
unsubscribe: Address: mercury-reviews-request at cs.mu.oz.au Message: unsubscribe
subscribe:   Address: mercury-reviews-request at cs.mu.oz.au Message: subscribe
--------------------------------------------------------------------------