GNU bug report logs - #38886
(read-variable) documentation doesn't match behavior

Previous Next

Package: emacs;

Reported by: Douglas Lewan <d.lewan2000 <at> gmail.com>

Date: Fri, 3 Jan 2020 02:29:02 UTC

Severity: minor

Tags: fixed

Fixed in version 28.1

Done: Lars Ingebrigtsen <larsi <at> gnus.org>

Bug is archived. No further changes may be made.

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 38886 in the body.
You can then email your comments to 38886 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

View this report as an mbox folder, status mbox, maintainer mbox


Report forwarded to bug-gnu-emacs <at> gnu.org:
bug#38886; Package emacs. (Fri, 03 Jan 2020 02:29:02 GMT) Full text and rfc822 format available.

Acknowledgement sent to Douglas Lewan <d.lewan2000 <at> gmail.com>:
New bug report received and forwarded. Copy sent to bug-gnu-emacs <at> gnu.org. (Fri, 03 Jan 2020 02:29:02 GMT) Full text and rfc822 format available.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Douglas Lewan <d.lewan2000 <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: (read-variable) documentation doesn't match behavior
Date: Thu, 2 Jan 2020 21:28:25 -0500
According to the documentation for (read-variable), this sexp 
(read-variable "?" '(all one top)) should return all if there's no 
input. It, however, signals an error instead: Wrong type argument: 
stringp, all. Indeed, this sexp (read-variable "?" '("all" "one" "top")) 
does return the symbol all

I'm guessing that that is in fact the intended behavior. (In the C code 
that seems to be the case.) However, the documentation is ambiguous. The 
first paragraph of the documentation would better end "... if it is a 
list of strings."

-- 
,Doug
d.lewan2000 <at> gmail.com
(908) 720 7908





Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#38886; Package emacs. (Fri, 21 Aug 2020 14:57:02 GMT) Full text and rfc822 format available.

Message #8 received at 38886 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Douglas Lewan <d.lewan2000 <at> gmail.com>
Cc: 38886 <at> debbugs.gnu.org
Subject: Re: bug#38886: (read-variable) documentation doesn't match behavior
Date: Fri, 21 Aug 2020 16:56:36 +0200
Douglas Lewan <d.lewan2000 <at> gmail.com> writes:

> According to the documentation for (read-variable), this sexp
> (read-variable "?" '(all one top)) should return all if there's no
> input. It, however, signals an error instead: Wrong type argument:
> stringp, all. Indeed, this sexp (read-variable "?" '("all" "one"
> "top")) does return the symbol all
>
> I'm guessing that that is in fact the intended behavior. (In the C
> code that seems to be the case.) However, the documentation is
> ambiguous. The first paragraph of the documentation would better end
> "... if it is a list of strings."

Yup.  I've now fixed the doc string in the way you suggest in Emacs 28.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no




Added tag(s) fixed. Request was from Lars Ingebrigtsen <larsi <at> gnus.org> to control <at> debbugs.gnu.org. (Fri, 21 Aug 2020 14:57:02 GMT) Full text and rfc822 format available.

bug marked as fixed in version 28.1, send any further explanations to 38886 <at> debbugs.gnu.org and Douglas Lewan <d.lewan2000 <at> gmail.com> Request was from Lars Ingebrigtsen <larsi <at> gnus.org> to control <at> debbugs.gnu.org. (Fri, 21 Aug 2020 14:57:02 GMT) Full text and rfc822 format available.

bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Sat, 19 Sep 2020 11:24:09 GMT) Full text and rfc822 format available.

This bug report was last modified 3 years and 191 days ago.

Previous Next


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