mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-04 03:44:55 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

bpo-39096: Improve description of 'e', 'f' and 'g' presentation types (#23537)

Browse source 
* Improve description of 'e', 'f' and 'g' presentation types

* Drop the 'E' from Scientific 'E' notation; remove >= 0 qualifications

* Fix false statement that the alternate form is valid for Decimal

* Nitpick: remove the Harvard/Oxford comma

* Add note that the decimal point is also removed if no digits follow it, except in alternate form
This commit is contained in:
Mark Dickinson 2020-11-29 09:34:36 +00:00 • committed by GitHub
parent 00a6568ba3
commit c642374b3e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 31 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

43
Doc/library/string.rst
View file

@ -384,10 +384,10 @@ following:
The ``'#'`` option causes the "alternate form" to be used for the The ``'#'`` option causes the "alternate form" to be used for the
conversion. The alternate form is defined differently for different conversion. The alternate form is defined differently for different
types. This option is only valid for integer, float, complex and types. This option is only valid for integer, float and complex
Decimal types. For integers, when binary, octal, or hexadecimal output types. For integers, when binary, octal, or hexadecimal output
is used, this option adds the prefix respective ``'0b'``, ``'0o'``, or is used, this option adds the prefix respective ``'0b'``, ``'0o'``, or
``'0x'`` to the output value. For floats, complex and Decimal the ``'0x'`` to the output value. For float and complex the
alternate form causes the result of the conversion to always contain a alternate form causes the result of the conversion to always contain a
decimal-point character, even if no digits follow it. Normally, a decimal-point character, even if no digits follow it. Normally, a
decimal-point character appears in the result of these conversions decimal-point character appears in the result of these conversions
@ -476,20 +476,36 @@ with the floating point presentation types listed below (except
``'n'`` and ``None``). When doing so, :func:`float` is used to convert the ``'n'`` and ``None``). When doing so, :func:`float` is used to convert the
integer to a floating point number before formatting. integer to a floating point number before formatting.
The available presentation types for floating point and decimal values are: The available presentation types for :class:`float` and
:class:`~decimal.Decimal` values are:
+---------+----------------------------------------------------------+ +---------+----------------------------------------------------------+
| Type | Meaning | | Type | Meaning |
+=========+==========================================================+ +=========+==========================================================+
| ``'e'`` | Exponent notation. Prints the number in scientific | | ``'e'`` | Scientific notation. For a given precision ``p``, |
| | notation using the letter 'e' to indicate the exponent. | | | formats the number in scientific notation with the |
| | The default precision is ``6``. | | | letter 'e' separating the coefficient from the exponent. |
| | The coefficient has one digit before and ``p`` digits |
| | after the decimal point, for a total of ``p + 1`` |
| | significant digits. With no precision given, uses a |
| | precision of ``6`` digits after the decimal point for |
| | :class:`float`, and shows all coefficient digits |
| | for :class:`~decimal.Decimal`. If no digits follow the |
| | decimal point, the decimal point is also removed unless |
| | the ``#`` option is used. |
+---------+----------------------------------------------------------+ +---------+----------------------------------------------------------+
| ``'E'`` | Exponent notation. Same as ``'e'`` except it uses an | | ``'E'`` | Scientific notation. Same as ``'e'`` except it uses |
| | upper case 'E' as the separator character. | | | an upper case 'E' as the separator character. |
+---------+----------------------------------------------------------+ +---------+----------------------------------------------------------+
| ``'f'`` | Fixed-point notation. Displays the number as a | | ``'f'`` | Fixed-point notation. For a given precision ``p``, |
| | fixed-point number. The default precision is ``6``. | | | formats the number as a decimal number with exactly |
| | ``p`` digits following the decimal point. With no |
| | precision given, uses a precision of ``6`` digits after |
| | the decimal point for :class:`float`, and uses a |
| | precision large enough to show all coefficient digits |
| | for :class:`~decimal.Decimal`. If no digits follow the |
| | decimal point, the decimal point is also removed unless |
| | the ``#`` option is used. |
+---------+----------------------------------------------------------+ +---------+----------------------------------------------------------+
| ``'F'`` | Fixed-point notation. Same as ``'f'``, but converts | | ``'F'`` | Fixed-point notation. Same as ``'f'``, but converts |
| | ``nan`` to ``NAN`` and ``inf`` to ``INF``. | | | ``nan`` to ``NAN`` and ``inf`` to ``INF``. |
@ -518,7 +534,10 @@ The available presentation types for floating point and decimal values are:
| | the precision. | | | the precision. |
| | | | | |
| | A precision of ``0`` is treated as equivalent to a | | | A precision of ``0`` is treated as equivalent to a |
| | precision of ``1``. The default precision is ``6``. | | | precision of ``1``. With no precision given, uses a |
| | precision of ``6`` significant digits for |
| | :class:`float`, and shows all coefficient digits |
| | for :class:`~decimal.Decimal`. |
+---------+----------------------------------------------------------+ +---------+----------------------------------------------------------+
| ``'G'`` | General format. Same as ``'g'`` except switches to | | ``'G'`` | General format. Same as ``'g'`` except switches to |
| | ``'E'`` if the number gets too large. The | | | ``'E'`` if the number gets too large. The |