@@ -24,24 +24,24 @@ Motivation
2424==========
2525
2626The :external+py3.14:mod: `math ` documentation says: "This module provides access
27- to the mathematical functions defined by the C standard." But as a state of
28- art, over time the module was populated with functions that aren't related to
27+ to the mathematical functions defined by the C standard." But,
28+ over time the module was populated with functions that aren't related to
2929the C standard or floating-point arithmetics. Now it's much harder to describe
3030module scope, content and interfaces (returned values or accepted arguments).
3131
3232For example, the :external+py3.14:mod: `math ` module documentation says: "Except
33- when explicitly noted otherwise, all return values are floats." This is not
33+ when explicitly noted otherwise, all return values are floats." This is no
3434longer true: *None * of the functions listed in the `Number-theoretic
3535functions <https://docs.python.org/3.14/library/math.html#number-theoretic-functions> `_
3636subsection of the documentation returns a float, but the
3737documentation doesn't say so. In the proposed module a similar sentence "All
3838return values are integers." could tell the truth once. In a similar way we
39- can simplify description of accepted arguments for both the
39+ can simplify the description of the accepted arguments for functions in both the
4040:external+py3.14:mod: `math ` and the new module.
4141
4242Apparently, the :external+py3.14:mod: `math ` can't serve as a catch-all place
4343for mathematical functions: we have also the :external+py3.14:mod: `cmath ` and
44- the :external+py3.14:mod: `statistics `. Let's make same for integer-related
44+ the :external+py3.14:mod: `statistics `. Let's do the same for integer-related
4545functions. It would provide shared context, which reduces verbosity in the
4646documentation and conceptual load. It also aids discoverability through
4747grouping related functions and IDEs suggesting helpful completions.
@@ -62,7 +62,7 @@ module, called ``imath``:
6262
6363Their aliases in :external+py3.14:mod: `math ` will be :term: `soft deprecated `.
6464
65- Modules functions will accept integers and objects that implement the
65+ Module functions will accept integers and objects that implement the
6666:external+py3.14:meth: `~object.__index__ ` method which is used to convert the
6767object to an integer number.
6868
0 commit comments