This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: math and cmath docs don't specify radians
Type: Stage:
Components: Documentation Versions:
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: tim.peters Nosy List: nnorwitz, rhettinger, tcdelaney, tim.peters
Priority: normal Keywords:

Created on 2004-07-23 07:18 by tcdelaney, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Messages (5)
msg21766 - (view) Author: Tim Delaney (tcdelaney) Date: 2004-07-23 07:18
The math and cmath functions take their parameters in 
radians, but there is nothing stating this.

The closest is "The math module consists mostly of thin 
wrappers around the platform C math library functions.".

For starters, are we guaranteed that the platform math 
functions take radians?
msg21767 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2004-07-24 20:27
Logged In: YES 
user_id=80475

Yes, the platform math lib will be in radians.

You're welcome to submit a clarifying doc patch.
msg21768 - (view) Author: Tim Peters (tim.peters) * (Python committer) Date: 2004-07-24 23:04
Logged In: YES 
user_id=31435

I checked in a major rewrite of the math module docs, as 
Doc/lib/libmath.tex revision 1.32.  This stuffed in "radians" as 
appropriate (among other things).

Note that the function docstrings already told the radiaion 
story; e.g.,

>>> print math.cos.__doc__
cos(x)

Return the cosine of x (measured in radians).
>>>

I didn't change the cmath docs, and don't intend to.  Anyone 
using complex "angles" who doesn't already know they're 
working in radians shouldn't be allowed to import cmath <0.6 
wink>.
msg21769 - (view) Author: Neal Norwitz (nnorwitz) * (Python committer) Date: 2004-08-02 22:14
Logged In: YES 
user_id=33168

Tim (Peters), did you want to do anything else on this or
should it be closed?
msg21770 - (view) Author: Tim Peters (tim.peters) * (Python committer) Date: 2004-08-02 23:01
Logged In: YES 
user_id=31435

Well, if I refuse to change cmath docs, chances are nobody 
else will, so closing this <wink>.  The math module docs were 
changed.
History
Date User Action Args
2022-04-11 14:56:05adminsetgithub: 40630
2004-07-23 07:18:05tcdelaneycreate