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: "Drew Adams" <drew.adams <at> oracle.com>
Subject: bug#4188 closed by Karl Fogel <kfogel <at> red-bean.com> (Fixed "doc
 strings in bookmark.el")
Date: Mon, 05 Oct 2009 01:45:08 +0000

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

This is an automatic notification regarding your bug report
which was filed against the emacs package:

#4188: 23.1; doc strings in bookmark.el

It has been closed by Karl Fogel <kfogel <at> red-bean.com>.

Their explanation is attached below along with your original report.
If this explanation is unsatisfactory and you have not received a
better one in a separate message then please contact Karl Fogel <kfogel <at> red-bean.com> by
replying to this email.


-- 
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: 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 part 3 (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)'
 

Previous Next

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