Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

Fix time.time() references in the time module docs 

Closes #14842.
This commit is contained in:
Petri Lehtinen 2012-05-18 21:19:17 +03:00
parent b15d1a7981
commit 1033b310a3
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Doc/library/time.rst
View File

@ -81,9 +81,9 @@ An explanation of some terminology and conventions is in order.
the units in which their value or argument is expressed. E.g. on most Unix the units in which their value or argument is expressed. E.g. on most Unix
systems, the clock "ticks" only 50 or 100 times a second. systems, the clock "ticks" only 50 or 100 times a second.
* On the other hand, the precision of :func:`time` and :func:`sleep` is better * On the other hand, the precision of :func:`.time` and :func:`sleep` is better
than their Unix equivalents: times are expressed as floating point numbers, than their Unix equivalents: times are expressed as floating point numbers,
:func:`time` returns the most accurate time available (using Unix :func:`.time` returns the most accurate time available (using Unix
:c:func:`gettimeofday` where available), and :func:`sleep` will accept a time :c:func:`gettimeofday` where available), and :func:`sleep` will accept a time
with a nonzero fraction (Unix :c:func:`select` is used to implement this, where with a nonzero fraction (Unix :c:func:`select` is used to implement this, where
available). available).
@ -177,7 +177,7 @@ The module defines the following functions and data items:
Convert a time expressed in seconds since the epoch to a string representing Convert a time expressed in seconds since the epoch to a string representing
local time. If *secs* is not provided or :const:`None`, the current time as local time. If *secs* is not provided or :const:`None`, the current time as
returned by :func:`time` is used. ``ctime(secs)`` is equivalent to returned by :func:`.time` is used. ``ctime(secs)`` is equivalent to
``asctime(localtime(secs))``. Locale information is not used by :func:`ctime`. ``asctime(localtime(secs))``. Locale information is not used by :func:`ctime`.
@ -190,7 +190,7 @@ The module defines the following functions and data items:
Convert a time expressed in seconds since the epoch to a :class:`struct_time` in Convert a time expressed in seconds since the epoch to a :class:`struct_time` in
UTC in which the dst flag is always zero. If *secs* is not provided or UTC in which the dst flag is always zero. If *secs* is not provided or
:const:`None`, the current time as returned by :func:`time` is used. Fractions :const:`None`, the current time as returned by :func:`.time` is used. Fractions
of a second are ignored. See above for a description of the of a second are ignored. See above for a description of the
:class:`struct_time` object. See :func:`calendar.timegm` for the inverse of this :class:`struct_time` object. See :func:`calendar.timegm` for the inverse of this
function. function.
@ -199,7 +199,7 @@ The module defines the following functions and data items:
.. function:: localtime([secs]) .. function:: localtime([secs])
Like :func:`gmtime` but converts to local time. If *secs* is not provided or Like :func:`gmtime` but converts to local time. If *secs* is not provided or
:const:`None`, the current time as returned by :func:`time` is used. The dst :const:`None`, the current time as returned by :func:`.time` is used. The dst
flag is set to ``1`` when DST applies to the given time. flag is set to ``1`` when DST applies to the given time.
@ -208,7 +208,7 @@ The module defines the following functions and data items:
This is the inverse function of :func:`localtime`. Its argument is the This is the inverse function of :func:`localtime`. Its argument is the
:class:`struct_time` or full 9-tuple (since the dst flag is needed; use ``-1`` :class:`struct_time` or full 9-tuple (since the dst flag is needed; use ``-1``
as the dst flag if it is unknown) which expresses the time in *local* time, not as the dst flag if it is unknown) which expresses the time in *local* time, not
UTC. It returns a floating point number, for compatibility with :func:`time`. UTC. It returns a floating point number, for compatibility with :func:`.time`.
If the input value cannot be represented as a valid time, either If the input value cannot be represented as a valid time, either
:exc:`OverflowError` or :exc:`ValueError` will be raised (which depends on :exc:`OverflowError` or :exc:`ValueError` will be raised (which depends on
whether the invalid value is caught by Python or the underlying C libraries). whether the invalid value is caught by Python or the underlying C libraries).