diff options
| author | Eli Zaretskii | 2024-10-27 13:16:36 +0200 |
|---|---|---|
| committer | Eli Zaretskii | 2024-10-27 13:16:36 +0200 |
| commit | b0aaee93fde245b972a0d69b60328550f53bc043 (patch) | |
| tree | 027474143244d079837c93577968747082d31c7e /doc | |
| parent | 299a1f240750595d7b0132aec5eb3a2b58c9d943 (diff) | |
| download | emacs-b0aaee93fde245b972a0d69b60328550f53bc043.tar.gz emacs-b0aaee93fde245b972a0d69b60328550f53bc043.zip | |
Update the documentation of void functions
* doc/lispref/functions.texi (Function Cells):
* src/data.c (Ffboundp, Ffmakunbound, Fsymbol_function): Update
documentation to the changes of how void functions are represented
since Emacs 24.5. (Bug#73886)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lispref/functions.texi | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/doc/lispref/functions.texi b/doc/lispref/functions.texi index 0131305525c..bfb8789d05b 100644 --- a/doc/lispref/functions.texi +++ b/doc/lispref/functions.texi | |||
| @@ -1511,9 +1511,9 @@ indirect-function}. | |||
| 1511 | This returns the object in the function cell of @var{symbol}. It does | 1511 | This returns the object in the function cell of @var{symbol}. It does |
| 1512 | not check that the returned object is a legitimate function. | 1512 | not check that the returned object is a legitimate function. |
| 1513 | 1513 | ||
| 1514 | If the function cell is void, the return value is @code{nil}. To | 1514 | If the function cell is void, the return value is @code{nil}. It is |
| 1515 | distinguish between a function cell that is void and one set to | 1515 | impossible to distinguish between a function cell that is void and one |
| 1516 | @code{nil}, use @code{fboundp} (see below). | 1516 | set to @code{nil}. |
| 1517 | 1517 | ||
| 1518 | @example | 1518 | @example |
| 1519 | @group | 1519 | @group |
| @@ -1538,24 +1538,24 @@ that that symbol's function cell is @dfn{void}. In other words, the | |||
| 1538 | function cell does not have any Lisp object in it. If you try to call | 1538 | function cell does not have any Lisp object in it. If you try to call |
| 1539 | the symbol as a function, Emacs signals a @code{void-function} error. | 1539 | the symbol as a function, Emacs signals a @code{void-function} error. |
| 1540 | 1540 | ||
| 1541 | Note that void is not the same as @code{nil} or the symbol | 1541 | Unlike with void variables (@pxref{Void Variables}), a symbol's |
| 1542 | @code{void}. The symbols @code{nil} and @code{void} are Lisp objects, | 1542 | function cell that contains @code{nil} is indistinguishable from the |
| 1543 | and can be stored into a function cell just as any other object can be | 1543 | function's being void. Note that void is not the same as the symbol |
| 1544 | (and @code{void} can be a valid function if you define it with | 1544 | @code{void}: @code{void} can be a valid function if you define it with |
| 1545 | @code{defun}). A void function cell contains no object whatsoever. | 1545 | @code{defun}. |
| 1546 | 1546 | ||
| 1547 | You can test the voidness of a symbol's function definition with | 1547 | You can test the voidness of a symbol's function definition with |
| 1548 | @code{fboundp}. After you have given a symbol a function definition, you | 1548 | @code{fboundp}. After you have given a symbol a function definition, you |
| 1549 | can make it void once more using @code{fmakunbound}. | 1549 | can make it void once more using @code{fmakunbound}. |
| 1550 | 1550 | ||
| 1551 | @defun fboundp symbol | 1551 | @defun fboundp symbol |
| 1552 | This function returns @code{t} if the symbol has an object in its | 1552 | This function returns @code{t} if the symbol has a non-@code{nil} object |
| 1553 | function cell, @code{nil} otherwise. It does not check that the object | 1553 | in its function cell, @code{nil} otherwise. It does not check that the |
| 1554 | is a legitimate function. | 1554 | object is a legitimate function. |
| 1555 | @end defun | 1555 | @end defun |
| 1556 | 1556 | ||
| 1557 | @defun fmakunbound symbol | 1557 | @defun fmakunbound symbol |
| 1558 | This function makes @var{symbol}'s function cell void, so that a | 1558 | This function makes @var{symbol}'s function cell @code{nil}, so that a |
| 1559 | subsequent attempt to access this cell will cause a | 1559 | subsequent attempt to access this cell will cause a |
| 1560 | @code{void-function} error. It returns @var{symbol}. (See also | 1560 | @code{void-function} error. It returns @var{symbol}. (See also |
| 1561 | @code{makunbound}, in @ref{Void Variables}.) | 1561 | @code{makunbound}, in @ref{Void Variables}.) |