summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDamien George <damien.p.george@gmail.com>2015-02-23 22:15:11 +0000
committerDamien George <damien.p.george@gmail.com>2015-02-23 22:15:11 +0000
commit4fddbe5ab6295d102630b84641f63e250bd8f894 (patch)
tree0f78c18697daffb737b709f60fe21b4edb26dee0
parent1babb6d0c723fa08fcbf8e48a0eeee476a42cd39 (diff)
docs: Correct the documentation for math.frexp.
-rw-r--r--docs/library/math.rst5
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/library/math.rst b/docs/library/math.rst
index 988a8c284..6ed42333c 100644
--- a/docs/library/math.rst
+++ b/docs/library/math.rst
@@ -90,7 +90,10 @@ Functions
.. function:: frexp(x)
- Converts a floating-point number to fractional and integral components.
+ Decomposes a floating-point number into its mantissa and exponent.
+ The returned value is the tuple ``(m, e)`` such that ``x == m * 2**e``
+ exactly. If ``x == 0`` then the function returns ``(0.0, 0)``, otherwise
+ the relation ``0.5 <= abs(m) < 1`` holds.
.. function:: gamma(x)