[Python-checkins] [3.9] [docs] Improve the markup of powers (GH-28598) (GH-28608)
ambv
webhook-mailer at python.org
Tue Sep 28 17:13:20 EDT 2021
https://github.com/python/cpython/commit/68223cd12f81adcb14f28f619d08a7f6a634fcc5
commit: 68223cd12f81adcb14f28f619d08a7f6a634fcc5
branch: 3.9
author: Łukasz Langa <lukasz at langa.pl>
committer: ambv <lukasz at langa.pl>
date: 2021-09-28T23:13:16+02:00
summary:
[3.9] [docs] Improve the markup of powers (GH-28598) (GH-28608)
(cherry picked from commit 4f05f15d7b25ef8b690cb94fdc4c8cb5521a4e27)
Co-authored-by: Serhiy Storchaka <storchaka at gmail.com>
files:
M Doc/library/functions.rst
M Doc/library/hashlib.rst
M Doc/library/ipaddress.rst
M Doc/library/plistlib.rst
M Doc/reference/datamodel.rst
M Doc/using/cmdline.rst
M Doc/whatsnew/2.0.rst
M Doc/whatsnew/2.7.rst
M Doc/whatsnew/3.1.rst
M Misc/NEWS.d/3.5.0a1.rst
M Misc/NEWS.d/3.6.4rc1.rst
M Misc/NEWS.d/3.7.0a3.rst
M Misc/NEWS.d/3.8.0a1.rst
M Misc/NEWS.d/3.9.0a1.rst
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index 15bfbf40462fc..4f967825fcbbb 100644
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -1298,8 +1298,8 @@ are always available. They are listed here in alphabetical order.
coercion rules for binary arithmetic operators apply. For :class:`int`
operands, the result has the same type as the operands (after coercion)
unless the second argument is negative; in that case, all arguments are
- converted to float and a float result is delivered. For example, ``10**2``
- returns ``100``, but ``10**-2`` returns ``0.01``.
+ converted to float and a float result is delivered. For example, ``pow(10, 2)``
+ returns ``100``, but ``pow(10, -2)`` returns ``0.01``.
For :class:`int` operands *base* and *exp*, if *mod* is present, *mod* must
also be of integer type and *mod* must be nonzero. If *mod* is present and
diff --git a/Doc/library/hashlib.rst b/Doc/library/hashlib.rst
index 615ee116bbb0b..f3e942b8af222 100644
--- a/Doc/library/hashlib.rst
+++ b/Doc/library/hashlib.rst
@@ -372,10 +372,10 @@ Constructor functions also accept the following tree hashing parameters:
* *depth*: maximal depth of tree (1 to 255, 255 if unlimited, 1 in
sequential mode).
-* *leaf_size*: maximal byte length of leaf (0 to 2**32-1, 0 if unlimited or in
+* *leaf_size*: maximal byte length of leaf (0 to ``2**32-1``, 0 if unlimited or in
sequential mode).
-* *node_offset*: node offset (0 to 2**64-1 for BLAKE2b, 0 to 2**48-1 for
+* *node_offset*: node offset (0 to ``2**64-1`` for BLAKE2b, 0 to ``2**48-1`` for
BLAKE2s, 0 for the first, leftmost, leaf, or in sequential mode).
* *node_depth*: node depth (0 to 255, 0 for leaves, or in sequential mode).
diff --git a/Doc/library/ipaddress.rst b/Doc/library/ipaddress.rst
index 2ab4dd83ad4de..74d922d29db69 100644
--- a/Doc/library/ipaddress.rst
+++ b/Doc/library/ipaddress.rst
@@ -41,7 +41,7 @@ IP addresses, networks and interfaces:
Return an :class:`IPv4Address` or :class:`IPv6Address` object depending on
the IP address passed as argument. Either IPv4 or IPv6 addresses may be
- supplied; integers less than 2**32 will be considered to be IPv4 by default.
+ supplied; integers less than ``2**32`` will be considered to be IPv4 by default.
A :exc:`ValueError` is raised if *address* does not represent a valid IPv4
or IPv6 address.
@@ -56,7 +56,7 @@ IP addresses, networks and interfaces:
Return an :class:`IPv4Network` or :class:`IPv6Network` object depending on
the IP address passed as argument. *address* is a string or integer
representing the IP network. Either IPv4 or IPv6 networks may be supplied;
- integers less than 2**32 will be considered to be IPv4 by default. *strict*
+ integers less than ``2**32`` will be considered to be IPv4 by default. *strict*
is passed to :class:`IPv4Network` or :class:`IPv6Network` constructor. A
:exc:`ValueError` is raised if *address* does not represent a valid IPv4 or
IPv6 address, or if the network has host bits set.
@@ -70,7 +70,7 @@ IP addresses, networks and interfaces:
Return an :class:`IPv4Interface` or :class:`IPv6Interface` object depending
on the IP address passed as argument. *address* is a string or integer
representing the IP address. Either IPv4 or IPv6 addresses may be supplied;
- integers less than 2**32 will be considered to be IPv4 by default. A
+ integers less than ``2**32`` will be considered to be IPv4 by default. A
:exc:`ValueError` is raised if *address* does not represent a valid IPv4 or
IPv6 address.
diff --git a/Doc/library/plistlib.rst b/Doc/library/plistlib.rst
index ce6d4a85bf5e9..5ded9661f0801 100644
--- a/Doc/library/plistlib.rst
+++ b/Doc/library/plistlib.rst
@@ -133,7 +133,7 @@ The following classes are available:
encoded data, which contains UID (see PList manual).
It has one attribute, :attr:`data`, which can be used to retrieve the int value
- of the UID. :attr:`data` must be in the range `0 <= data < 2**64`.
+ of the UID. :attr:`data` must be in the range ``0 <= data < 2**64``.
.. versionadded:: 3.8
diff --git a/Doc/reference/datamodel.rst b/Doc/reference/datamodel.rst
index 47fbcacad5f96..94f7e5a23b8a4 100644
--- a/Doc/reference/datamodel.rst
+++ b/Doc/reference/datamodel.rst
@@ -1492,7 +1492,7 @@ Basic customization
This is intended to provide protection against a denial-of-service caused
by carefully-chosen inputs that exploit the worst case performance of a
- dict insertion, O(n^2) complexity. See
+ dict insertion, O(n\ :sup:`2`) complexity. See
http://www.ocert.org/advisories/ocert-2011-003.html for details.
Changing hash values affects the iteration order of sets.
diff --git a/Doc/using/cmdline.rst b/Doc/using/cmdline.rst
index 23d66ec7a829c..5739388ecc5f7 100644
--- a/Doc/using/cmdline.rst
+++ b/Doc/using/cmdline.rst
@@ -322,7 +322,7 @@ Miscellaneous options
Hash randomization is intended to provide protection against a
denial-of-service caused by carefully-chosen inputs that exploit the worst
- case performance of a dict construction, O(n^2) complexity. See
+ case performance of a dict construction, O(n\ :sup:`2`) complexity. See
http://www.ocert.org/advisories/ocert-2011-003.html for details.
:envvar:`PYTHONHASHSEED` allows you to set a fixed value for the hash
diff --git a/Doc/whatsnew/2.0.rst b/Doc/whatsnew/2.0.rst
index ace396b9d846a..dd49da8f7653e 100644
--- a/Doc/whatsnew/2.0.rst
+++ b/Doc/whatsnew/2.0.rst
@@ -791,7 +791,7 @@ Previously the Python virtual machine used 16-bit numbers in its bytecode,
limiting the size of source files. In particular, this affected the maximum
size of literal lists and dictionaries in Python source; occasionally people who
are generating Python code would run into this limit. A patch by Charles G.
-Waldman raises the limit from ``2^16`` to ``2^{32}``.
+Waldman raises the limit from ``2**16`` to ``2**32``.
Three new convenience functions intended for adding constants to a module's
dictionary at module initialization time were added: :func:`PyModule_AddObject`,
diff --git a/Doc/whatsnew/2.7.rst b/Doc/whatsnew/2.7.rst
index d19c8e01ad8a0..abb65222ddd3d 100644
--- a/Doc/whatsnew/2.7.rst
+++ b/Doc/whatsnew/2.7.rst
@@ -953,12 +953,12 @@ Several performance enhancements have been added:
considered and traversed by the collector.
(Contributed by Antoine Pitrou; :issue:`4688`.)
-* Long integers are now stored internally either in base 2**15 or in base
- 2**30, the base being determined at build time. Previously, they
- were always stored in base 2**15. Using base 2**30 gives
+* Long integers are now stored internally either in base ``2**15`` or in base
+ ``2**30``, the base being determined at build time. Previously, they
+ were always stored in base ``2**15``. Using base ``2**30`` gives
significant performance improvements on 64-bit machines, but
benchmark results on 32-bit machines have been mixed. Therefore,
- the default is to use base 2**30 on 64-bit machines and base 2**15
+ the default is to use base ``2**30`` on 64-bit machines and base ``2**15``
on 32-bit machines; on Unix, there's a new configure option
:option:`!--enable-big-digits` that can be used to override this default.
diff --git a/Doc/whatsnew/3.1.rst b/Doc/whatsnew/3.1.rst
index 919fbeeb2ad85..f1e6d0c4f3dd6 100644
--- a/Doc/whatsnew/3.1.rst
+++ b/Doc/whatsnew/3.1.rst
@@ -474,12 +474,12 @@ Build and C API Changes
Changes to Python's build process and to the C API include:
-* Integers are now stored internally either in base 2**15 or in base
- 2**30, the base being determined at build time. Previously, they
- were always stored in base 2**15. Using base 2**30 gives
+* Integers are now stored internally either in base ``2**15`` or in base
+ ``2**30``, the base being determined at build time. Previously, they
+ were always stored in base ``2**15``. Using base ``2**30`` gives
significant performance improvements on 64-bit machines, but
benchmark results on 32-bit machines have been mixed. Therefore,
- the default is to use base 2**30 on 64-bit machines and base 2**15
+ the default is to use base ``2**30`` on 64-bit machines and base ``2**15``
on 32-bit machines; on Unix, there's a new configure option
``--enable-big-digits`` that can be used to override this default.
diff --git a/Misc/NEWS.d/3.5.0a1.rst b/Misc/NEWS.d/3.5.0a1.rst
index 56d0d33decc0c..fc5093ef370b0 100644
--- a/Misc/NEWS.d/3.5.0a1.rst
+++ b/Misc/NEWS.d/3.5.0a1.rst
@@ -2648,7 +2648,7 @@ module.
.. nonce: THJSYB
.. section: Library
-Changed FeedParser feed() to avoid O(N**2) behavior when parsing long line.
+Changed FeedParser feed() to avoid O(N\ :sup:`2`) behavior when parsing long line.
Original patch by Raymond Hettinger.
..
diff --git a/Misc/NEWS.d/3.6.4rc1.rst b/Misc/NEWS.d/3.6.4rc1.rst
index 36dfadda0fe1b..dc9ab7ad56de8 100644
--- a/Misc/NEWS.d/3.6.4rc1.rst
+++ b/Misc/NEWS.d/3.6.4rc1.rst
@@ -22,7 +22,7 @@ Setting sys.tracebacklimit to 0 or less now suppresses printing tracebacks.
Setting sys.tracebacklimit to None now causes using the default limit.
Setting sys.tracebacklimit to an integer larger than LONG_MAX now means using
the limit LONG_MAX rather than the default limit.
-Fixed integer overflows in the case of more than 2**31 traceback items on
+Fixed integer overflows in the case of more than ``2**31`` traceback items on
Windows.
Fixed output errors handling.
diff --git a/Misc/NEWS.d/3.7.0a3.rst b/Misc/NEWS.d/3.7.0a3.rst
index 8ef7a5118a1f5..067720efa516e 100644
--- a/Misc/NEWS.d/3.7.0a3.rst
+++ b/Misc/NEWS.d/3.7.0a3.rst
@@ -100,7 +100,7 @@ Setting sys.tracebacklimit to 0 or less now suppresses printing tracebacks.
Setting sys.tracebacklimit to None now causes using the default limit.
Setting sys.tracebacklimit to an integer larger than LONG_MAX now means using
the limit LONG_MAX rather than the default limit.
-Fixed integer overflows in the case of more than 2**31 traceback items on
+Fixed integer overflows in the case of more than ``2**31`` traceback items on
Windows.
Fixed output errors handling.
diff --git a/Misc/NEWS.d/3.8.0a1.rst b/Misc/NEWS.d/3.8.0a1.rst
index b7164a5b4e0fa..657ea5cab925c 100644
--- a/Misc/NEWS.d/3.8.0a1.rst
+++ b/Misc/NEWS.d/3.8.0a1.rst
@@ -3355,7 +3355,7 @@ if the ``PATH`` environment variable is not set.
On Windows, fix multiprocessing.Connection for very large read: fix
_winapi.PeekNamedPipe() and _winapi.ReadFile() for read larger than INT_MAX
-(usually 2^31-1).
+(usually ``2**31-1``).
..
diff --git a/Misc/NEWS.d/3.9.0a1.rst b/Misc/NEWS.d/3.9.0a1.rst
index fe9fc58e3979a..0a6a6eb287145 100644
--- a/Misc/NEWS.d/3.9.0a1.rst
+++ b/Misc/NEWS.d/3.9.0a1.rst
@@ -213,7 +213,7 @@ objects. Patch by Dong-hee Na and Inada Naoki.
.. section: Core and Builtins
:class:`bytearray`, :class:`~array.array` and :class:`~mmap.mmap` objects
-allow now to export more than 2**31 buffers at a time.
+allow now to export more than ``2**31`` buffers at a time.
..
More information about the Python-checkins
mailing list