Skip to content

Commit 48caa4b

Browse files
committed
Rephrase Rationale
1 parent 3054b20 commit 48caa4b

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

peps/pep-0791.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -108,12 +108,12 @@ with the :external+py3.14:func:`~math.ceil` (which is for :class:`float`'s and
108108
Rationale
109109
=========
110110

111-
Why not fix the :external+py3.14:mod:`math` module documentation instead?
112-
Sure, we can be much more vague in the module preamble (i.e. roughly say that
113-
"the :external+py3.14:mod:`math` module contains some mathematical functions"),
114-
we can accurately describe input/output for each function and its behavior
115-
(e.g. whether the :external+py3.14:func:`~math.factorial` output is exact or
116-
not, like the `scipy.special.factorial
111+
Is this all about documentation, why not fix it instead? No, it isn't. Sure,
112+
we can be much more vague in the module preamble (i.e. roughly say that "the
113+
:external+py3.14:mod:`math` module contains some mathematical functions"), we
114+
can accurately describe input/output for each function and its behavior (e.g.
115+
whether the :external+py3.14:func:`~math.factorial` output is exact or not,
116+
like the `scipy.special.factorial
117117
<https://docs.scipy.org/doc/scipy/reference/generated/scipy.special.factorial.html#scipy.special.factorial>`_,
118118
per default).
119119

0 commit comments

Comments
 (0)