Repository navigation
Discrepancy in argument naming for Sphinx docs & help in the cmath module #125957
Description
For example, cmath.sin docs looks like:
Lines 147 to 149 in 2513593
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 uses z to denote complex numbers, just as many textbooks.
Also, per PDEB 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.
Activity
[-]Disgrepancy in argument naming for sphinx docs & help in the cmath module[/-][+]Discrepancy in argument naming for sphinx docs & help in the cmath module[/+]pythongh-125957: sync argument naming in sphinx docs of the cmath and…
gh-125957: sync argument naming in sphinx docs of the cmath and help…
pythongh-125957: sync argument naming in sphinx docs of the cmath and…
pythongh-125957: sync argument naming in sphinx docs of the cmath and…
[3.13] gh-125957: sync argument naming in sphinx docs of the cmath an…
[3.12] gh-125957: sync argument naming in sphinx docs of the cmath an…
[-]Discrepancy in argument naming for sphinx docs & help in the cmath module[/-][+]Discrepancy in argument naming for Sphinx docs & help in the cmath module[/+]