unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
* bug#41026: Improve documentation of `makunbound' and `fmakunbound'
@ 2020-05-02 13:53 Stefan Kangas
  2020-05-02 14:03 ` Eli Zaretskii
  2020-05-02 14:55 ` Andreas Schwab
  0 siblings, 2 replies; 18+ messages in thread
From: Stefan Kangas @ 2020-05-02 13:53 UTC (permalink / raw)
  To: 41026

[-- Attachment #1: Type: text/plain, Size: 111 bytes --]

Severity: wishlist

Any objections to or comments on the attached patch?  Thanks.

Best regards,
Stefan Kangas

[-- Attachment #2: 0001-Improve-doc-strings-of-makunbound-and-fmakunbound.patch --]
[-- Type: text/x-patch, Size: 1379 bytes --]

From f1cab1061f02cb88c9e63a67935e9701cee3781d Mon Sep 17 00:00:00 2001
From: Stefan Kangas <stefankangas@gmail.com>
Date: Sat, 2 May 2020 15:51:31 +0200
Subject: [PATCH] Improve doc strings of makunbound and fmakunbound

* src/data.c (Fmakunbound, Ffmakunbound): Improve doc strings.
---
 src/data.c | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

diff --git a/src/data.c b/src/data.c
index bce2e53cfb..e7b9e74a30 100644
--- a/src/data.c
+++ b/src/data.c
@@ -695,8 +695,12 @@ DEFUN ("fboundp", Ffboundp, Sfboundp, 1, 1, 0,
 }
 
 DEFUN ("makunbound", Fmakunbound, Smakunbound, 1, 1, 0,
-       doc: /* Make SYMBOL's value be void.
-Return SYMBOL.  */)
+       doc: /* Make variable SYMBOL's value be void.
+Return SYMBOL.
+
+For more information, see Info node `(elisp) Void Variables'.
+
+The corresponding operation for functions is `fmakunbound'.  */)
   (register Lisp_Object symbol)
 {
   CHECK_SYMBOL (symbol);
@@ -708,7 +712,11 @@ DEFUN ("makunbound", Fmakunbound, Smakunbound, 1, 1, 0,
 
 DEFUN ("fmakunbound", Ffmakunbound, Sfmakunbound, 1, 1, 0,
        doc: /* Make SYMBOL's function definition be nil.
-Return SYMBOL.  */)
+Return SYMBOL.
+
+For more information, see Info node `(elisp) Function Cells'.
+
+The corresponding operation for variables is `makunbound'.  */)
   (register Lisp_Object symbol)
 {
   CHECK_SYMBOL (symbol);
-- 
2.26.2


^ permalink raw reply related	[flat|nested] 18+ messages in thread

end of thread, other threads:[~2020-05-04 13:05 UTC | newest]

Thread overview: 18+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2020-05-02 13:53 bug#41026: Improve documentation of `makunbound' and `fmakunbound' Stefan Kangas
2020-05-02 14:03 ` Eli Zaretskii
2020-05-02 14:17   ` Stefan Kangas
2020-05-02 14:22     ` Eli Zaretskii
2020-05-02 20:25       ` Stefan Kangas
2020-05-02 21:12         ` Andreas Schwab
2020-05-02 21:30           ` Stefan Kangas
2020-05-04  3:06           ` Richard Stallman
2020-05-04  7:31             ` Andreas Schwab
2020-05-04 12:52               ` Stefan Kangas
2020-05-04 13:05                 ` Andreas Schwab
2020-05-03 14:21         ` Eli Zaretskii
2020-05-03 20:07           ` Stefan Kangas
2020-05-02 14:55 ` Andreas Schwab
2020-05-02 15:00   ` Stefan Kangas
2020-05-02 15:41     ` Eli Zaretskii
2020-05-02 20:22   ` Drew Adams
2020-05-03  3:43   ` Richard Stallman

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).