[Python-checkins] bpo-23460: Fix documentation for decimal string :g formatting (GH-11850)

[Julien Palard]

https://github.com/python/cpython/commit/1660a61a105bcd62e2dfa77885959a8992e9f14e
commit: 1660a61a105bcd62e2dfa77885959a8992e9f14e
branch: master
author: Brennan D Baraban <34765317+bdbaraban at users.noreply.github.com>
committer: Julien Palard <julien at palard.fr>
date: 2019-09-11T15:59:37+02:00
summary:

bpo-23460: Fix documentation for decimal string :g formatting (GH-11850)

files:
A Misc/NEWS.d/next/Documentation/2019-02-14-07-12-48.bpo-23460.Iqiqtm.rst
M Doc/library/string.rst

diff --git a/Doc/library/string.rst b/Doc/library/string.rst
index af8b9b358cc3..af52af0482c4 100644
--- a/Doc/library/string.rst
+++ b/Doc/library/string.rst
@@ -500,9 +500,10 @@ The available presentation types for floating point and decimal values are:
    |         |                                                          |
    |         | The precise rules are as follows: suppose that the       |
    |         | result formatted with presentation type ``'e'`` and      |
-   |         | precision ``p-1`` would have exponent ``exp``.  Then     |
-   |         | if ``-4 <= exp < p``, the number is formatted            |
-   |         | with presentation type ``'f'`` and precision             |
+   |         | precision ``p-1`` would have exponent ``exp``.  Then,    |
+   |         | if ``m <= exp < p``, where ``m`` is -4 for floats and -6 |
+   |         | for :class:`Decimals <decimal.Decimal>`, the number is   |
+   |         | formatted with presentation type ``'f'`` and precision   |
    |         | ``p-1-exp``.  Otherwise, the number is formatted         |
    |         | with presentation type ``'e'`` and precision ``p-1``.    |
    |         | In both cases insignificant trailing zeros are removed   |
diff --git a/Misc/NEWS.d/next/Documentation/2019-02-14-07-12-48.bpo-23460.Iqiqtm.rst b/Misc/NEWS.d/next/Documentation/2019-02-14-07-12-48.bpo-23460.Iqiqtm.rst
new file mode 100644
index 000000000000..4674d551d379
--- /dev/null
+++ b/Misc/NEWS.d/next/Documentation/2019-02-14-07-12-48.bpo-23460.Iqiqtm.rst
@@ -0,0 +1 @@
+The documentation for decimal string formatting using the `:g` specifier has been updated to reflect the correct exponential notation cutoff point. Original patch contributed by Tuomas Suutari.
\ No newline at end of file