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

Previous Next

Package: emacs;

Reported by: "Drew Adams" <drew.adams <at> oracle.com>

Date: Thu, 20 Aug 2009 19:51:13 UTC

Severity: minor

Merged with 4296

Done: Karl Fogel <kfogel <at> red-bean.com>

Bug is archived. No further changes may be made.

Full log

View this message in rfc822 format

From: "Drew Adams" <drew.adams <at> oracle.com>
To: <bug-gnu-emacs <at> gnu.org>
Subject: bug#4188: 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)'
This bug report was last modified 15 years and 224 days ago.

Previous Next

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