summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorBrad Wolfe <brad.wolfe@gmail.com>2022-11-27 10:25:12 (GMT)
committerGitHub <noreply@github.com>2022-11-27 10:25:12 (GMT)
commit65629399bcfe2a6606b8201d190877f7f54e6be5 (patch)
tree453fe1b2f9edcac143d81836e874480d02107ad6 /Doc/library
parent22860dbbc8b53954055847d2bb036af68b4ea409 (diff)
downloadcpython-65629399bcfe2a6606b8201d190877f7f54e6be5.zip
cpython-65629399bcfe2a6606b8201d190877f7f54e6be5.tar.gz
cpython-65629399bcfe2a6606b8201d190877f7f54e6be5.tar.bz2
gh-85988: Change documentation for sys.float_info.rounds (GH-99675)
* Change documentation for sys.float_info.rounds Change the documentation for sys.float_info.rounds to remove references to C99 section 5.2.4.2.2 and instead place the available values inline. * Correction to previous documentation change Newlines were not preserved in generated HTML on previous commit. I have changes the list to a comma-separated list of values and their meanings. * Clarify source for value of FLT_ROUNDS Clarify the source of the FLT_ROUNDS value and change 'floating-point addition' to 'floating-point arithmetic' to indicate that the rounding mode applies to all arithmetic operations.
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/sys.rst18
1 files changed, 12 insertions, 6 deletions
diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst
index d54ecd7..428ce51 100644
--- a/Doc/library/sys.rst
+++ b/Doc/library/sys.rst
@@ -604,12 +604,18 @@ always available.
+---------------------+----------------+--------------------------------------------------+
| :const:`radix` | FLT_RADIX | radix of exponent representation |
+---------------------+----------------+--------------------------------------------------+
- | :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. |
+ | :const:`rounds` | FLT_ROUNDS | integer representing the rounding mode for |
+ | | | floating-point arithmetic. This reflects the |
+ | | | value of the system FLT_ROUNDS macro at |
+ | | | interpreter startup time: |
+ | | | ``-1`` indeterminable, |
+ | | | ``0`` toward zero, |
+ | | | ``1`` to nearest, |
+ | | | ``2`` toward positive infinity, |
+ | | | ``3`` toward negative infinity |
+ | | | |
+ | | | All other values for FLT_ROUNDS characterize |
+ | | | implementation-defined rounding behavior. |
+---------------------+----------------+--------------------------------------------------+
The attribute :attr:`sys.float_info.dig` needs further explanation. If