* bug#29551: 24.5; doc string of `bookmark-alist'
@ 2017-12-03 23:41 Drew Adams
2017-12-04 0:01 ` Drew Adams
2017-12-09 9:19 ` Eli Zaretskii
0 siblings, 2 replies; 3+ messages in thread
From: Drew Adams @ 2017-12-03 23:41 UTC (permalink / raw)
To: 29551
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'
^ permalink raw reply [flat|nested] 3+ messages in thread
* bug#29551: 24.5; doc string of `bookmark-alist'
2017-12-03 23:41 bug#29551: 24.5; doc string of `bookmark-alist' Drew Adams
@ 2017-12-04 0:01 ` Drew Adams
2017-12-09 9:19 ` Eli Zaretskii
1 sibling, 0 replies; 3+ messages in thread
From: Drew Adams @ 2017-12-04 0:01 UTC (permalink / raw)
To: 29551
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.
^ permalink raw reply [flat|nested] 3+ messages in thread
* bug#29551: 24.5; doc string of `bookmark-alist'
2017-12-03 23:41 bug#29551: 24.5; doc string of `bookmark-alist' Drew Adams
2017-12-04 0:01 ` Drew Adams
@ 2017-12-09 9:19 ` Eli Zaretskii
1 sibling, 0 replies; 3+ messages in thread
From: Eli Zaretskii @ 2017-12-09 9:19 UTC (permalink / raw)
To: Drew Adams; +Cc: 29551-done
> Date: Sun, 3 Dec 2017 15:41:10 -0800 (PST)
> From: Drew Adams <drew.adams@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.
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2017-12-09 9:19 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2017-12-03 23:41 bug#29551: 24.5; doc string of `bookmark-alist' Drew Adams
2017-12-04 0:01 ` Drew Adams
2017-12-09 9:19 ` Eli Zaretskii
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).