diff options
| author | Stefan Kangas | 2020-05-03 22:00:02 +0200 |
|---|---|---|
| committer | Stefan Kangas | 2020-05-03 22:01:23 +0200 |
| commit | f9fa726cede2d90501e5b8f0d93bfa4ce134868d (patch) | |
| tree | 0da0ff77c885fc13e6b2726b10365aeb509b7a4f /src | |
| parent | e90b7b9ef2af00fb206052bc4458d7e692e5d413 (diff) | |
| download | emacs-f9fa726cede2d90501e5b8f0d93bfa4ce134868d.tar.gz emacs-f9fa726cede2d90501e5b8f0d93bfa4ce134868d.zip | |
Improve doc strings of makunbound and fmakunbound
* src/data.c (Fmakunbound, Ffmakunbound): Improve doc
strings. (Bug#41026)
Diffstat (limited to 'src')
| -rw-r--r-- | src/data.c | 20 |
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, | |||
| 701 | } | 701 | } |
| 702 | 702 | ||
| 703 | DEFUN ("makunbound", Fmakunbound, Smakunbound, 1, 1, 0, | 703 | DEFUN ("makunbound", Fmakunbound, Smakunbound, 1, 1, 0, |
| 704 | doc: /* Make SYMBOL's value be void. | 704 | doc: /* Empty out the value cell of SYMBOL, making it void as a variable. |
| 705 | Return SYMBOL. */) | 705 | Return SYMBOL. |
| 706 | |||
| 707 | If a variable is void, trying to evaluate the variable signals a | ||
| 708 | `void-variable' error, instead of returning a value. For more | ||
| 709 | details, see Info node `(elisp) Void Variables'. | ||
| 710 | |||
| 711 | See also `fmakunbound'. */) | ||
| 706 | (register Lisp_Object symbol) | 712 | (register Lisp_Object symbol) |
| 707 | { | 713 | { |
| 708 | CHECK_SYMBOL (symbol); | 714 | CHECK_SYMBOL (symbol); |
| @@ -713,8 +719,14 @@ Return SYMBOL. */) | |||
| 713 | } | 719 | } |
| 714 | 720 | ||
| 715 | DEFUN ("fmakunbound", Ffmakunbound, Sfmakunbound, 1, 1, 0, | 721 | DEFUN ("fmakunbound", Ffmakunbound, Sfmakunbound, 1, 1, 0, |
| 716 | doc: /* Make SYMBOL's function definition be nil. | 722 | doc: /* Make SYMBOL's function definition be void. |
| 717 | Return SYMBOL. */) | 723 | Return SYMBOL. |
| 724 | |||
| 725 | If a function definition is void, trying to call a function by that | ||
| 726 | name will cause a `void-function' error. For more details, see Info | ||
| 727 | node `(elisp) Function Cells'. | ||
| 728 | |||
| 729 | See also `makunbound'. */) | ||
| 718 | (register Lisp_Object symbol) | 730 | (register Lisp_Object symbol) |
| 719 | { | 731 | { |
| 720 | CHECK_SYMBOL (symbol); | 732 | CHECK_SYMBOL (symbol); |