summaryrefslogtreecommitdiff
path: root/src/data.c
diff options
context:
space:
mode:
authorStefan Kangas <stefankangas@gmail.com>2020-05-03 22:00:02 +0200
committerStefan Kangas <stefankangas@gmail.com>2020-05-03 22:01:23 +0200
commitf9fa726cede2d90501e5b8f0d93bfa4ce134868d (patch)
tree0da0ff77c885fc13e6b2726b10365aeb509b7a4f /src/data.c
parente90b7b9ef2af00fb206052bc4458d7e692e5d413 (diff)
downloademacs-f9fa726cede2d90501e5b8f0d93bfa4ce134868d.tar.gz
Improve doc strings of makunbound and fmakunbound
* src/data.c (Fmakunbound, Ffmakunbound): Improve doc strings. (Bug#41026)
Diffstat (limited to 'src/data.c')
-rw-r--r--src/data.c20
1 files changed, 16 insertions, 4 deletions
diff --git a/src/data.c b/src/data.c
index 5ce5e360ab4..0f3ac8c6571 100644
--- a/src/data.c
+++ b/src/data.c
@@ -701,8 +701,14 @@ DEFUN ("fboundp", Ffboundp, Sfboundp, 1, 1, 0,
}
DEFUN ("makunbound", Fmakunbound, Smakunbound, 1, 1, 0,
- doc: /* Make SYMBOL's value be void.
-Return SYMBOL. */)
+ doc: /* Empty out the value cell of SYMBOL, making it void as a variable.
+Return SYMBOL.
+
+If a variable is void, trying to evaluate the variable signals a
+`void-variable' error, instead of returning a value. For more
+details, see Info node `(elisp) Void Variables'.
+
+See also `fmakunbound'. */)
(register Lisp_Object symbol)
{
CHECK_SYMBOL (symbol);
@@ -713,8 +719,14 @@ Return SYMBOL. */)
}
DEFUN ("fmakunbound", Ffmakunbound, Sfmakunbound, 1, 1, 0,
- doc: /* Make SYMBOL's function definition be nil.
-Return SYMBOL. */)
+ doc: /* Make SYMBOL's function definition be void.
+Return SYMBOL.
+
+If a function definition is void, trying to call a function by that
+name will cause a `void-function' error. For more details, see Info
+node `(elisp) Function Cells'.
+
+See also `makunbound'. */)
(register Lisp_Object symbol)
{
CHECK_SYMBOL (symbol);