Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork32k
Description
For example, cmath.sin docslooks like:
Lines 147 to 149 in2513593
..function::sin(x) | |
Return the sine of *x*. |
while help() shows:
>>> help(cmath.sin)Help on built-in function sin in module cmath:sin(z, /) Return the sine of z.
Note that help() has the "/" to show, that the parameter name is not a part of API (positional-only parameter), but the sphinx docs miss that part.
I think it's a good idea to sync parameter naming in help and sphinx. Note that the introduction in sphinx docs usesz
to denote complex numbers, just as many textbooks.
Also, perPDEB decision, sphinx docs should include a slash to denote positional-only arguments. I propose instead allow positional-or-keyword arguments for functions of this module. In this way we can preserve simple (e.g.sin(z)
) function signatures, while preserving "precision and completeness" of reference docs.
Linked PRs
Metadata
Metadata
Assignees
Projects
Status