]> git.eshelyaron.com Git - emacs.git/commitdiff
Improve documentation of the 'function' special form
authorMichael Heerdegen <michael_heerdegen@web.de>
Sat, 27 Apr 2019 07:40:10 +0000 (09:40 +0200)
committerMichael Heerdegen <michael_heerdegen@web.de>
Thu, 23 May 2019 22:51:46 +0000 (00:51 +0200)
Point out that 'function' quoting is beneficial also for symbols.

* src/eval.c (function): Enhance docstring.
* doc/lispref/functions.texi (Anonymous Functions): Improve
documentation.

doc/lispref/functions.texi
src/eval.c

index 97f7fb9f79e266a72b0dda3f3a6e881419a651a6..2f9d898c9b02eea4d594bbea498f414c5cb327b6 100644 (file)
@@ -1122,6 +1122,10 @@ a byte-code function object (@pxref{Byte Compilation}).
 When lexical binding is enabled, @var{function-object} is converted
 into a closure.  @xref{Closures}.
 @end itemize
+
+When @var{function-object} is a symbol and the code is byte compiled,
+the byte-compiler will warn if that function is not defined or might
+not be known at run time.
 @end defspec
 
 @cindex @samp{#'} syntax
index 567c32e0d75acfa798517010af66de28c092db06..5bba876637382f65b042fac77765832265ba0fb5 100644 (file)
@@ -544,8 +544,8 @@ usage: (quote ARG)  */)
 
 DEFUN ("function", Ffunction, Sfunction, 1, UNEVALLED, 0,
        doc: /* Like `quote', but preferred for objects which are functions.
-In byte compilation, `function' causes its argument to be compiled.
-`quote' cannot do that.
+In byte compilation, `function' causes its argument to be handled by
+the byte compiler.  `quote' cannot do that.
 usage: (function ARG)  */)
   (Lisp_Object args)
 {