GNU bug report logs - #4188
23.1; doc strings in bookmark.el

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 4188 in the body.
You can then email your comments to 4188 AT debbugs.gnu.org in the normal way.

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

Message #5 received at submit <at> emacsbugs.donarmstrong.com (full text, mbox):

From: "Drew Adams" <drew.adams <at> oracle.com>
To: <bug-gnu-emacs <at> gnu.org>
Subject: 23.1; doc strings in bookmark.el
Date: Wed, 19 Aug 2009 15:23:50 -0700

1. The function doc strings need to describe the arguments.
 
For example, these functions (at least) should say,
"BOOKMARK is a bookmark name or a bookmark record."
 
bookmark-get-bookmark, bookmark-get-bookmark-record,
bookmark-prop-get, bookmark-prop-set, bookmark-get-handler,
bookmark--jump-via, bookmark-jump-noselect.
 
This is particularly important because some functions expect that
their bookmark argument be a bookmark name, others expect that it be a
bookmark record, and still others allow either.
 

2. Some functions (e.g. bookmark--jump-via) are missing doc strings
altogether.
 
 
 
In GNU Emacs 23.1.1 (i386-mingw-nt5.1.2600)
 of 2009-07-29 on SOFT-MJASON
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (4.4)'
 

Message #12 received at 4188-close <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Karl Fogel <kfogel <at> red-bean.com>
To: 4188-close <at> debbugs.gnu.org
Subject: Fixed "doc strings in bookmark.el"
Date: Sun, 04 Oct 2009 21:36:31 -0400

fixed
--

Thanks for the report.  Fix committed:

  $ cvs ci -F msg lisp/bookmark.el lisp/ChangeLog
  /sources/emacs/emacs/lisp/bookmark.el,v  <--  lisp/bookmark.el
  new revision: 1.128; previous revision: 1.127
  /sources/emacs/emacs/lisp/ChangeLog,v  <--  lisp/ChangeLog
  new revision: 1.16354; previous revision: 1.16353
  Mailing notification to emacs-diffs <at> gnu.org... sent.
  $ 

Message #22 received at submit <at> emacsbugs.donarmstrong.com (full text, mbox):

From: "Drew Adams" <drew.adams <at> oracle.com>
To: "'Karl Fogel'" <kfogel <at> red-bean.com>, <bug-gnu-emacs <at> gnu.org>
Subject: RE: bug#4188: marked as done (23.1; doc strings in bookmark.el)
Date: Sat, 10 Oct 2009 11:17:55 -0700

>> 2. Some functions (e.g. bookmark--jump-via) are missing doc strings
>> altogether.


There are still some things that need doc strings.

`bookmark-current-buffer', for instance. The doc strings of other functions
(e.g. `bookmark-yank-word' need to refer to this buffer, but they cannot refer
to it by name, since `buffer-current-buffer' has no doc string.

Message #27 received at submit <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Karl Fogel <kfogel <at> red-bean.com>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: <bug-gnu-emacs <at> gnu.org>
Subject: Re: bug#4188: marked as done (23.1; doc strings in bookmark.el)
Date: Sat, 10 Oct 2009 17:55:01 -0400

"Drew Adams" <drew.adams <at> oracle.com> writes:
>>> 2. Some functions (e.g. bookmark--jump-via) are missing doc strings
>>> altogether.
>
> There are still some things that need doc strings.
>
> `bookmark-current-buffer', for instance. The doc strings of other
> functions (e.g. `bookmark-yank-word' need to refer to this buffer, but
> they cannot refer to it by name, since `buffer-current-buffer' has no
> doc string.

Oops, sorry, missed the variables.  Fixed in these two revs:

  $ cvs ci -F msg lisp/bookmark.el lisp/ChangeLog
  /sources/emacs/emacs/lisp/bookmark.el,v  <--  lisp/bookmark.el
  new revision: 1.135; previous revision: 1.134
  /sources/emacs/emacs/lisp/ChangeLog,v  <--  lisp/ChangeLog
  new revision: 1.16400; previous revision: 1.16399
  Mailing notification to emacs-diffs <at> gnu.org... sent.
  $ cvs ci -F msg lisp/bookmark.el lisp/ChangeLog
  /sources/emacs/emacs/lisp/bookmark.el,v  <--  lisp/bookmark.el
  new revision: 1.136; previous revision: 1.135
  /sources/emacs/emacs/lisp/ChangeLog,v  <--  lisp/ChangeLog
  new revision: 1.16401; previous revision: 1.16400
  Mailing notification to emacs-diffs <at> gnu.org... sent.
  $ 

Previous Next

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