summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorVictor Stinner <victor.stinner@gmail.com>2012-06-12 20:11:44 (GMT)
committerVictor Stinner <victor.stinner@gmail.com>2012-06-12 20:11:44 (GMT)
commitbda4b8802c9693cd1c6f97cc09e34c4f63b030ef (patch)
tree11f93eb6d6dbfc683d52c53bbba5fae881bb0e49 /Doc
parentd9738242f82109e01561131efecb2e20da93d743 (diff)
downloadcpython-bda4b8802c9693cd1c6f97cc09e34c4f63b030ef.zip
cpython-bda4b8802c9693cd1c6f97cc09e34c4f63b030ef.tar.gz
cpython-bda4b8802c9693cd1c6f97cc09e34c4f63b030ef.tar.bz2
time.get_clock_info() uses a namespace instead of structseq
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/time.rst36
1 files changed, 11 insertions, 25 deletions
diff --git a/Doc/library/time.rst b/Doc/library/time.rst
index a8c70b3..ba6b176 100644
--- a/Doc/library/time.rst
+++ b/Doc/library/time.rst
@@ -160,30 +160,6 @@ The module defines the following functions and data items:
.. versionadded:: 3.3
-.. class:: clock_info
-
- Clock information object returned by :func:`get_clock_info`.
-
- .. attribute:: implementation
-
- The name of the underlying C function used to get the clock value.
-
- .. attribute:: monotonic
-
- ``True`` if the clock cannot go backward, ``False`` otherwise.
-
- .. attribute:: adjusted
-
- ``True`` if the clock can be adjusted (e.g. by a NTP daemon), ``False``
- otherwise.
-
- .. attribute:: resolution
-
- The resolution of the clock in seconds (:class:`float`).
-
- .. versionadded:: 3.3
-
-
.. function:: clock_settime(clk_id, time)
Set the time of the specified clock *clk_id*.
@@ -267,7 +243,7 @@ The module defines the following functions and data items:
.. function:: get_clock_info(name)
- Get information on the specified clock as a :class:`clock_info` object.
+ Get information on the specified clock as a namespace object.
Supported clock names and the corresponding functions to read their value
are:
@@ -277,6 +253,16 @@ The module defines the following functions and data items:
* ``'process_time'``: :func:`time.process_time`
* ``'time'``: :func:`time.time`
+ The result has the following attributes:
+
+ - *adjusted*: ``True`` if the clock can be adjusted (e.g. by a NTP daemon),
+ ``False`` otherwise
+ - *implementation*: The name of the underlying C function used to get
+ the clock value
+ - *monotonic*: ``True`` if the clock cannot go backward,
+ ``False`` otherwise
+ - *resolution*: The resolution of the clock in seconds (:class:`float`)
+
.. versionadded:: 3.3