changeset 81743:79a229b4a7de

(math-approx-pi,math-approx-sqrt-e,math-approx-gamma-const): Add docstrings.
author Jay Belanger <jay.p.belanger@gmail.com>
date Sat, 07 Jul 2007 23:57:23 +0000
parents 3340bf730dea
children f245856314bf
files lisp/calc/calc-ext.el
diffstat 1 files changed, 8 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/lisp/calc/calc-ext.el	Sat Jul 07 23:56:56 2007 +0000
+++ b/lisp/calc/calc-ext.el	Sat Jul 07 23:57:23 2007 +0000
@@ -1925,9 +1925,11 @@
 (put 'math-defcache 'lisp-indent-hook 2)
 
 ;;; Betcha didn't know that pi = 16 atan(1/5) - 4 atan(1/239).   [F] [Public]
-(defconst math-approx-pi 
+(defconst math-approx-pi
   (eval-when-compile
-    (math-read-number-simple "3.141592653589793238463")))
+    (math-read-number-simple "3.141592653589793238463"))
+  "An approximation for pi.")
+
 (math-defcache math-pi math-approx-pi
   (math-add-float (math-mul-float '(float 16 0)
 				  (math-arctan-raw '(float 2 -1)))
@@ -1960,7 +1962,8 @@
   (math-sqrt-float (math-two-pi)))
 
 (defconst math-approx-sqrt-e
-  (eval-when-compile (math-read-number-simple "1.648721270700128146849")))
+  (eval-when-compile (math-read-number-simple "1.648721270700128146849"))
+  "An approximation for sqrt(3).")
     
 (math-defcache math-sqrt-e math-approx-sqrt-e
   (math-add-float '(float 1 0) (math-exp-minus-1-raw '(float 5 -1))))
@@ -1975,7 +1978,8 @@
 (defconst math-approx-gamma-const
   (eval-when-compile
     (math-read-number-simple 
-     "0.5772156649015328606065120900824024310421593359399235988057672348848677267776646709369470632917467495")))
+     "0.5772156649015328606065120900824024310421593359399235988057672348848677267776646709369470632917467495"))
+  "An approximation for gamma.")
 
 (math-defcache math-gamma-const nil 
   math-approx-gamma-const)