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

Previous Next

Package: emacs;

Reported by: Stefan Kangas <stefan <at> marxist.se>

Date: Sat, 2 May 2020 13:55:01 UTC

Severity: wishlist

Fixed in version 27.1

Done: Stefan Kangas <stefan <at> marxist.se>

Bug is archived. No further changes may be made.

Full log

View this message in rfc822 format

From: Richard Stallman <rms <at> gnu.org>
To: Andreas Schwab <schwab <at> linux-m68k.org>
Cc: 41026 <at> debbugs.gnu.org, stefan <at> marxist.se
Subject: bug#41026: Improve documentation of `makunbound' and `fmakunbound'
Date: Sat, 02 May 2020 23:43:28 -0400

[[[ To any NSA and FBI agents reading my email: please consider    ]]]
[[[ whether defending the US Constitution against all enemies,     ]]]
[[[ foreign or domestic, requires you to follow Snowden's example. ]]]

  > > +       doc: /* Make variable SYMBOL's value be void.

  > What's a variable symbol?

That is a grammatical misparsing.
That sentence does not talk about a "variable symbol".
It talks about a variable, and SYMBOL stands for that variable.
It is like  "the buffer BUF".

Would it be clearer to say "Make the variable VAR's value be void"
and call the argument 'var'?

-- 
Dr Richard Stallman
Chief GNUisance of the GNU Project (https://gnu.org)
Founder, Free Software Foundation (https://fsf.org)
Internet Hall-of-Famer (https://internethalloffame.org)
This bug report was last modified 5 years and 101 days ago.

Previous Next

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