Skip to content

Commit

Permalink
[3.11] gh-90744: Fix erroneous doc links in the sys module (GH-101319) (
Browse files Browse the repository at this point in the history 
#102321)

Co-authored-by: Hugo van Kemenade <[email protected]>
Co-authored-by: Brad Wolfe <[email protected]>
Co-authored-by: Furkan Onder <[email protected]>
Fix erroneous doc links in the sys module (#101319)
  • Loading branch information
@hugovk
hugovk authored Mar 2, 2023
1 parent 3effcce commit 9a5f2e8
Showing 1 changed file with 49 additions and 43 deletions.
92 changes: 49 additions & 43 deletions Doc/library/sys.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -568,49 +568,55 @@ always available.

.. tabularcolumns:: |l|l|L|

+---------------------+----------------+--------------------------------------------------+
| attribute | float.h macro | explanation |
+=====================+================+==================================================+
| :const:`epsilon` | DBL_EPSILON | difference between 1.0 and the least value |
| | | greater than 1.0 that is representable as a float|
| | | |
| | | See also :func:`math.ulp`. |
+---------------------+----------------+--------------------------------------------------+
| :const:`dig` | DBL_DIG | maximum number of decimal digits that can be |
| | | faithfully represented in a float; see below |
+---------------------+----------------+--------------------------------------------------+
| :const:`mant_dig` | DBL_MANT_DIG | float precision: the number of base-``radix`` |
| | | digits in the significand of a float |
+---------------------+----------------+--------------------------------------------------+
| :const:`max` | DBL_MAX | maximum representable positive finite float |
+---------------------+----------------+--------------------------------------------------+
| :const:`max_exp` | DBL_MAX_EXP | maximum integer *e* such that ``radix**(e-1)`` is|
| | | a representable finite float |
+---------------------+----------------+--------------------------------------------------+
| :const:`max_10_exp` | DBL_MAX_10_EXP | maximum integer *e* such that ``10**e`` is in the|
| | | range of representable finite floats |
+---------------------+----------------+--------------------------------------------------+
| :const:`min` | DBL_MIN | minimum representable positive *normalized* float|
| | | |
| | | Use :func:`math.ulp(0.0) <math.ulp>` to get the |
| | | smallest positive *denormalized* representable |
| | | float. |
+---------------------+----------------+--------------------------------------------------+
| :const:`min_exp` | DBL_MIN_EXP | minimum integer *e* such that ``radix**(e-1)`` is|
| | | a normalized float |
+---------------------+----------------+--------------------------------------------------+
| :const:`min_10_exp` | DBL_MIN_10_EXP | minimum integer *e* such that ``10**e`` is a |
| | | normalized float |
+---------------------+----------------+--------------------------------------------------+
| :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. |
+---------------------+----------------+--------------------------------------------------+
+---------------------+---------------------+--------------------------------------------------+
| attribute | float.h macro | explanation |
+=====================+=====================+==================================================+
| ``epsilon`` | ``DBL_EPSILON`` | difference between 1.0 and the least value |
| | | greater than 1.0 that is representable as a float|
| | | |
| | | See also :func:`math.ulp`. |
+---------------------+---------------------+--------------------------------------------------+
| ``dig`` | ``DBL_DIG`` | maximum number of decimal digits that can be |
| | | faithfully represented in a float; see below |
+---------------------+---------------------+--------------------------------------------------+
| ``mant_dig`` | ``DBL_MANT_DIG`` | float precision: the number of base-``radix`` |
| | | digits in the significand of a float |
+---------------------+---------------------+--------------------------------------------------+
| ``max`` | ``DBL_MAX`` | maximum representable positive finite float |
+---------------------+---------------------+--------------------------------------------------+
| ``max_exp`` | ``DBL_MAX_EXP`` | maximum integer *e* such that ``radix**(e-1)`` is|
| | | a representable finite float |
+---------------------+---------------------+--------------------------------------------------+
| ``max_10_exp`` | ``DBL_MAX_10_EXP`` | maximum integer *e* such that ``10**e`` is in the|
| | | range of representable finite floats |
+---------------------+---------------------+--------------------------------------------------+
| ``min`` | ``DBL_MIN`` | minimum representable positive *normalized* float|
| | | |
| | | Use :func:`math.ulp(0.0) <math.ulp>` to get the |
| | | smallest positive *denormalized* representable |
| | | float. |
+---------------------+---------------------+--------------------------------------------------+
| ``min_exp`` | ``DBL_MIN_EXP`` | minimum integer *e* such that ``radix**(e-1)`` is|
| | | a normalized float |
+---------------------+---------------------+--------------------------------------------------+
| ``min_10_exp`` | ``DBL_MIN_10_EXP`` | minimum integer *e* such that ``10**e`` is a |
| | | normalized float |
+---------------------+---------------------+--------------------------------------------------+
| ``radix`` | ``FLT_RADIX`` | radix of exponent representation |
+---------------------+---------------------+--------------------------------------------------+
| ``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
``s`` is any string representing a decimal number with at most
Expand Down

0 comments on commit 9a5f2e8

Please sign in to comment.