GNU bug report logs - #29551
24.5; doc string of `bookmark-alist'

Previous Next

Package: emacs;

Reported by: Drew Adams <drew.adams <at> oracle.com>

Date: Sun, 3 Dec 2017 23:42:02 UTC

Severity: minor

Found in version 24.5

Done: Eli Zaretskii <eliz <at> gnu.org>

Bug is archived. No further changes may be made.

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Drew Adams <drew.adams <at> oracle.com>
Subject: bug#29551: closed (Re: bug#29551: 24.5; doc string of
 `bookmark-alist')
Date: Sat, 09 Dec 2017 09:20:02 +0000

[Message part 1 (text/plain, inline)]
Your bug report

#29551: 24.5; doc string of `bookmark-alist'

which was filed against the emacs package, has been closed.

The explanation is attached below, along with your original report.
If you require more details, please reply to 29551 <at> debbugs.gnu.org.

-- 
29551: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=29551
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems

[Message part 2 (message/rfc822, inline)]
From: Eli Zaretskii <eliz <at> gnu.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 29551-done <at> debbugs.gnu.org
Subject: Re: bug#29551: 24.5; doc string of `bookmark-alist'
Date: Sat, 09 Dec 2017 11:19:09 +0200

> Date: Sun, 3 Dec 2017 15:41:10 -0800 (PST)
> From: Drew Adams <drew.adams <at> oracle.com>
> 
> A bookmark is more than a name.
> 
> The first line of the doc string says this:
> 
>   Association list of bookmarks and their records.
> 
> That's wrong, or at best misleading.  Each entry in the alist is a
> _bookmark_.  That is, each entry is a bookmark "record", whose car
> is the bookmark name, and whose cdr is the associated bookmark data.
> 
> The doc should say something like this:
> 
> "Association list of bookmark names and bookmark data."
> or
> "Association list of bookmark records." (and then say what a record is)

Thanks, fixed.


[Message part 3 (message/rfc822, inline)]
From: Drew Adams <drew.adams <at> oracle.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 24.5; doc string of `bookmark-alist'
Date: Sun, 3 Dec 2017 15:41:10 -0800 (PST)

A bookmark is more than a name.

The first line of the doc string says this:

  Association list of bookmarks and their records.

That's wrong, or at best misleading.  Each entry in the alist is a
_bookmark_.  That is, each entry is a bookmark "record", whose car
is the bookmark name, and whose cdr is the associated bookmark data.

The doc should say something like this:

"Association list of bookmark names and bookmark data."
or
"Association list of bookmark records." (and then say what a record is)

In GNU Emacs 24.5.1 (i686-pc-mingw32)
 of 2015-04-11 on LEG570
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --prefix=/c/usr --host=i686-pc-mingw32'
This bug report was last modified 7 years and 225 days ago.

Previous Next

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