]> git.eshelyaron.com Git - emacs.git/commitdiff
(cl-macroexpand): keep documentation from `macroexpand'.
authorRichard M. Stallman <rms@gnu.org>
Tue, 1 Nov 1994 04:21:03 +0000 (04:21 +0000)
committerRichard M. Stallman <rms@gnu.org>
Tue, 1 Nov 1994 04:21:03 +0000 (04:21 +0000)
lisp/emacs-lisp/cl.el

index fca1ab7d5725e727c534f2dac776434066453328..3d0a3c496026af32cb08c1e49113474a121677cb 100644 (file)
@@ -254,6 +254,13 @@ Keywords supported:  :test :test-not :key"
                             (defalias 'macroexpand 'cl-macroexpand)))
 
 (defun cl-macroexpand (cl-macro &optional cl-env)
+  "Return result of expanding macros at top level of FORM.
+If FORM is not a macro call, it is returned unchanged.
+Otherwise, the macro is expanded and the expansion is considered
+in place of FORM.  When a non-macro-call results, it is returned.
+
+The second optional arg ENVIRONMENT species an environment of macro
+definitions to shadow the loaded ones for use in file byte-compilation."
   (let ((cl-macro-environment cl-env))
     (while (progn (setq cl-macro (funcall cl-old-macroexpand cl-macro cl-env))
                  (and (symbolp cl-macro)