From: Mark Dickinson <mdickinson@enthought.com>
Date: Sat, 19 Nov 2011 16:26:45 +0000 (+0000)
Subject: Issue #12245: Document sys.float_info.rounds better.
X-Git-Tag: v3.3.0a1~807^2
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=b1e58fe43f14ccf0a67589142ea643493b348c2b;p=python

Issue #12245: Document sys.float_info.rounds better.
---

diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst
index fdf188faef..c18dfdbb1a 100644
--- a/Doc/library/sys.rst
+++ b/Doc/library/sys.rst
@@ -296,8 +296,12 @@ always available.
    +---------------------+----------------+--------------------------------------------------+
    | :const:`radix`      | FLT_RADIX      | radix of exponent representation                 |
    +---------------------+----------------+--------------------------------------------------+
-   | :const:`rounds`     | FLT_ROUNDS     | constant representing rounding mode              |
-   |                     |                | used for arithmetic operations                   |
+   | :const:`rounds`     | FLT_ROUNDS     | integer constant representing the rounding mode  |
+   |                     |                | used for arithmetic operations.  This reflects   |
+   |                     |                | the value of the system FLT_ROUNDS macro at      |
+   |                     |                | interpreter startup time.  See section 5.2.4.2.2 |
+   |                     |                | of the C99 standard for an explanation of the    |
+   |                     |                | possible values and their meanings.              |
    +---------------------+----------------+--------------------------------------------------+
 
    The attribute :attr:`sys.float_info.dig` needs further explanation.  If