-
-
Notifications
You must be signed in to change notification settings - Fork 32.4k
Closed as not planned
Labels
docsDocumentation in the Doc dirDocumentation in the Doc dir
Description
>>> import math
>>> help(math.exp)
Help on built-in function exp in module math:
exp(x, /)
Return e raised to the power of x.
I would rephrase this as: "Return the exponential of x." (like the Mathematica docs). Same for expm1() or with log()/log1p().
The problem with the current text is that here is a disambiguation of the Euler's number e vs the math.e (an approximation of). Sometimes this is explained in the sphinx docs: e.g. for same exp() it says "Return e raised to the power x, where e = 2.718281… is the base of natural logarithms.". But sometimes not: e.g. for log() or log1p().
I think, using "the exponential of" or "the natural logarithm of" in the docstrings and sphinx docs will be better.
Linked PRs
Metadata
Metadata
Assignees
Labels
docsDocumentation in the Doc dirDocumentation in the Doc dir