Skip to content

Improve the markup of powers in docs #28598

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 28, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Doc/library/functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1345,8 +1345,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``.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool, I always found it weird not to use the function in question in those examples.


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
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/hashlib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -376,10 +376,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).
Expand Down
6 changes: 3 additions & 3 deletions Doc/library/ipaddress.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See how the GitHub syntax highlighter is confused with the old text.

A :exc:`ValueError` is raised if *address* does not represent a valid IPv4
or IPv6 address.

Expand All @@ -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.
Expand All @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion Doc/library/plistlib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion Doc/reference/datamodel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1558,7 +1558,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.
Expand Down
2 changes: 1 addition & 1 deletion Doc/using/cmdline.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion Doc/whatsnew/2.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`,
Expand Down
8 changes: 4 additions & 4 deletions Doc/whatsnew/2.7.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
8 changes: 4 additions & 4 deletions Doc/whatsnew/3.1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
10 changes: 5 additions & 5 deletions Doc/whatsnew/3.11.rst
Original file line number Diff line number Diff line change
Expand Up @@ -243,14 +243,14 @@ time
----

* On Unix, :func:`time.sleep` now uses the ``clock_nanosleep()`` or
``nanosleep()`` function, if available, which has a resolution of 1 ns (10^-9
sec), rather than using ``select()`` which has a resolution of 1 us (10^-6
sec).
``nanosleep()`` function, if available, which has a resolution of 1 ns
(10\ :sup:`-9` sec), rather than using ``select()`` which has a resolution
of 1 us (10\ :sup:`-6` sec).
(Contributed by Livius and Victor Stinner in :issue:`21302`.)

* On Windows, :func:`time.sleep` now uses a waitable timer which has a
resolution of 100 ns (10^-7 sec). Previously, it had a solution of 1 ms
(10^-3 sec).
resolution of 100 ns (10\ :sup:`-7` sec). Previously, it had a solution of 1 ms
(10\ :sup:`-3` sec).
(Contributed by Livius and Victor Stinner in :issue:`21302`.)

unicodedata
Expand Down
2 changes: 1 addition & 1 deletion Misc/NEWS.d/3.5.0a1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

..
Expand Down
2 changes: 1 addition & 1 deletion Misc/NEWS.d/3.6.4rc1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion Misc/NEWS.d/3.7.0a3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion Misc/NEWS.d/3.8.0a1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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``).

..

Expand Down
2 changes: 1 addition & 1 deletion Misc/NEWS.d/3.9.0a1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

..

Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Fixed pickling of range iterators that iterated for over 2**32 times.
Fixed pickling of range iterators that iterated for over ``2**32`` times.
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Improve accuracy of variance calculations by using x*x instead of x**2.
Improve accuracy of variance calculations by using ``x*x`` instead of ``x**2``.
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
On Windows, :func:`time.sleep` now uses a waitable timer which has a resolution
of 100 ns (10^-7 sec). Previously, it had a solution of 1 ms (10^-3 sec).
of 100 ns (10\ :sup:`-7` sec). Previously, it had a solution of 1 ms (10\ :sup:`-3` sec).
Patch by Livius and Victor Stinner.