From: "Drew Adams" <drew.adams@oracle.com>
To: <bug-gnu-emacs@gnu.org>
Subject: bug#4188: 23.1; doc strings in bookmark.el
Date: Wed, 19 Aug 2009 15:23:50 -0700 [thread overview]
Message-ID: <93AC19018012425A8D3A6E2163301F3A@us.oracle.com> (raw)
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)'
next reply other threads:[~2009-08-19 22:23 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <87y6nqmxk0.fsf@red-bean.com>
2009-08-19 22:23 ` Drew Adams [this message]
2009-10-05 1:45 ` bug#4188: marked as done (23.1; doc strings in bookmark.el) Emacs bug Tracking System
2009-10-10 18:17 ` Drew Adams
2009-10-10 21:55 ` Karl Fogel
2009-08-31 7:45 ` bug#4296: 23.1; Change bookmark comments to docstring Thierry Volpiatto
2009-10-05 1:45 ` bug#4296: marked as done (23.1; Change bookmark comments to docstring.) Emacs bug Tracking System
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=93AC19018012425A8D3A6E2163301F3A@us.oracle.com \
--to=drew.adams@oracle.com \
--cc=4188@emacsbugs.donarmstrong.com \
--cc=bug-gnu-emacs@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.