changeset 96394:c594284b21d1

(defmath): Add `doc-string' decl. Add docstring.
author John Paul Wallington <jpw@pobox.com>
date Sat, 28 Jun 2008 14:14:29 +0000
parents 269a30341454
children 3dcb178d4fdc
files lisp/calc/calc.el
diffstat 1 files changed, 11 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/lisp/calc/calc.el	Sat Jun 28 10:17:22 2008 +0000
+++ b/lisp/calc/calc.el	Sat Jun 28 14:14:29 2008 +0000
@@ -3663,6 +3663,17 @@
 
 ;;;###autoload
 (defmacro defmath (func args &rest body)   ;  [Public]
+  "Define Calc function.
+
+Like `defun' except that code in the body of the definition can
+make use of the full range of Calc data types and the usual
+arithmetic operations are converted to their Calc equivalents.
+
+The prefix `calcFunc-' is added to the specified name to get the
+actual Lisp function name.
+
+See Info node `(calc)Defining Functions'."
+  (declare (doc-string 3))
   (require 'calc-ext)
   (math-do-defmath func args body))