File tree Expand file tree Collapse file tree 1 file changed +16
-0
lines changed
Expand file tree Collapse file tree 1 file changed +16
-0
lines changed Original file line number Diff line number Diff line change @@ -54,6 +54,22 @@ simple wrapper to the ``libm``, as most functions in the
5454:external+py3.14:mod: `math ` module.
5555
5656
57+ Rationale
58+ =========
59+
60+ Why not fix the :external+py3.14:mod: `math ` module documentation instead?
61+ Sure, we can be much more vague in the module preamble (i.e. roughly say
62+ that "the :external+py3.14:mod: `math ` module contains some mathematical
63+ functions") and we can accurately describe input/output for each function.
64+
65+ But the major issue is that current module mix different, almost non-interlaced
66+ application domains. Adding more documentation will just highlight this and
67+ make the issue worse for end users (more stuff to read/skip). And it will not
68+ fix issue with discoverability (to know in which module to find a function, and
69+ that it can be found at all, you need to look at all the functions in the
70+ module), nor with tab-completion.
71+
72+
5773Specification
5874=============
5975
You can’t perform that action at this time.
0 commit comments