GNU bug report logs - #41026
Improve documentation of `makunbound' and `fmakunbound'

Previous Next

Full log

View this message in rfc822 format

From: Eli Zaretskii <eliz <at> gnu.org>
To: Stefan Kangas <stefan <at> marxist.se>
Cc: 41026 <at> debbugs.gnu.org
Subject: bug#41026: Improve documentation of `makunbound' and `fmakunbound'
Date: Sat, 02 May 2020 17:22:39 +0300

> From: Stefan Kangas <stefan <at> marxist.se>
> Cc: 41026 <at> debbugs.gnu.org
> Date: Sat, 02 May 2020 16:17:04 +0200
> 
> >> +The corresponding operation for functions is `fmakunbound'.  */)
> >    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> > The "corresponding" part isn't accurate, is it?
> 
> Sorry, I thought it was.  But my understanding of this is probably
> much too naive.
> 
> Would we avoid the inaccuracy by deleting the word "corresponding"?

I'd just say "See also `fmakunbound'".  And the same in the
fmakunbound doc string.

Btw, why the link to the manual?  Does the manual say something
important that the doc strings don't?  If it does, perhaps we should
make the laconic doc string slightly more elaborate?

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.