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

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (Emacs bug Tracking System)
To: Karl Fogel <kfogel <at> red-bean.com>
Subject: bug#4188: marked as done (23.1; doc strings in bookmark.el)
Date: Mon, 05 Oct 2009 01:45:08 +0000

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

Your message dated Sun, 04 Oct 2009 21:36:31 -0400
with message-id <87y6nqmxk0.fsf <at> red-bean.com>
and subject line Fixed "doc strings in bookmark.el"
has caused the Emacs bug report #4188,
regarding 23.1; doc strings in bookmark.el
to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact help-debbugs <at> gnu.org
immediately.)


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

[Message part 2 (message/rfc822, inline)]

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 part 3 (message/rfc822, inline)]

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.
  $ 

Previous Next

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