[ python-Bugs-996392 ] math and cmath docs don't specify radians

[SourceForge.net]

Bugs item #996392, was opened at 2004-07-23 03:18
Message generated for change (Comment added) made by tim_one
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=996392&group_id=5470

Category: Documentation
Group: None
>Status: Closed
>Resolution: Fixed
Priority: 5
Submitted By: Tim Delaney (tcdelaney)
>Assigned to: Tim Peters (tim_one)
Summary: math and cmath docs don't specify radians

Initial Comment:
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?

----------------------------------------------------------------------

>Comment By: Tim Peters (tim_one)
Date: 2004-08-02 19:01

Message:
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.

----------------------------------------------------------------------

Comment By: Neal Norwitz (nnorwitz)
Date: 2004-08-02 18:14

Message:
Logged In: YES 
user_id=33168

Tim (Peters), did you want to do anything else on this or
should it be closed?

----------------------------------------------------------------------

Comment By: Tim Peters (tim_one)
Date: 2004-07-24 19:04

Message:
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>.

----------------------------------------------------------------------

Comment By: Raymond Hettinger (rhettinger)
Date: 2004-07-24 16:27

Message:
Logged In: YES 
user_id=80475

Yes, the platform math lib will be in radians.

You're welcome to submit a clarifying doc patch.

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=996392&group_id=5470