From: Stefan Krah <skrah@bytereef.org>
Date: Sun, 30 Sep 2012 07:24:41 +0000 (+0200)
Subject: Make it clear that the pi function is modified for benchmarking purposes.
X-Git-Tag: v3.4.0a1~2453^2
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=9a3f05e60f7c620404ddb63dc1ef48b4a11ad78f;p=python

Make it clear that the pi function is modified for benchmarking purposes.
---

diff --git a/Modules/_decimal/tests/bench.py b/Modules/_decimal/tests/bench.py
index 7ab6b4464c..7e4a210cd5 100644
--- a/Modules/_decimal/tests/bench.py
+++ b/Modules/_decimal/tests/bench.py
@@ -18,8 +18,13 @@ except ImportError:
 C = import_fresh_module('decimal', fresh=['_decimal'])
 P = import_fresh_module('decimal', blocked=['_decimal'])
 
-
-# Pi function from the decimal.py documentation
+#
+# NOTE: This is the pi function from the decimal documentation, modified
+# for benchmarking purposes. Since floats do not have a context, the higher
+# intermediate precision from the original is NOT used, so the modified
+# algorithm only gives an approximation to the correctly rounded result.
+# For serious use, refer to the documentation or the appropriate literature.
+#
 def pi_float():
     """native float"""
     lasts, t, s, n, na, d, da = 0, 3.0, 3, 1, 0, 0, 24