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

Previous Next

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

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

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

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'

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

From: Drew Adams <drew.adams <at> oracle.com>
To: 29551 <at> debbugs.gnu.org
Subject: RE: bug#29551: 24.5; doc string of `bookmark-alist'
Date: Sun, 3 Dec 2017 16:01:23 -0800 (PST)

In addition, this sentence should be removed from
the doc string:

 "An entry with a key but null value means the
  entry is not used."

That's just not true.  (It might be true for the
fields used by default, but even then that fact
is unimportant.)

It is not true generally.  Anyone can program new
bookmark types, with any data whatsoever in their
records.  What the meaning/behavior of a nil field
value might be is determined only by the code that
creates and uses such a bookmark.

Message #13 received at 29551-done <at> debbugs.gnu.org (full text, mbox):

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.

Previous Next

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