[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#7548: [FIXED] bookmark-default-handler wrong documentation
From: |
Karl Fogel |
Subject: |
bug#7548: [FIXED] bookmark-default-handler wrong documentation |
Date: |
Wed, 08 Dec 2010 03:12:51 -0500 |
Thanks, Leo and Theirry. Fixed in bzr rev 102609. Specifically:
------------------------------------------------------------
revno: 102609
revision-id: kfogel@red-bean.com-20101208080927-5j9jqnb2xvcw4ogm
parent: rgm@gnu.org-20101208050012-qhxovv7ey54v8w3h
committer: Karl Fogel <kfogel@red-bean.com>
branch nick: trunk
timestamp: Wed 2010-12-08 03:09:27 -0500
message:
Adjust parameter names and doc strings to resolve confusion over
whether "bookmark" meant a bookmark name or a bookmark record.
Along the way, shorten one function's name for similar reasons.
(Issue #7548)
* lisp/bookmark.el
(bookmark-name-from-record):
New name for `bookmark-name-from-full-record'. All callers changed.
(bookmark-get-bookmark, bookmark-get-bookmark-record,
bookmark-default-annotation-text, bookmark-prop-get, bookmark-prop-set,
bookmark-get-annotation, bookmark-set-annotation,
bookmark-get-filename, bookmark-set-filename,
bookmark-get-position, bookmark-set-position,
bookmark-get-front-context-string, bookmark-set-front-context-string,
bookmark-get-rear-context-string, bookmark-set-rear-context-string,
bookmark-get-handler, bookmark-edit-annotation, bookmark--jump-via,
bookmark-handle-bookmark, bookmark-location, bookmark-show-annotation):
Rename `bookmark' parameter to `bookmark-name-or-record', to
clearly show its role, and shorten or adjust doc strings accordingly.
(bookmark-set-name):
Same, and pass the parameter directly to `bookmark-get-bookmark'
instead of redundantly doing the callee's work.
(bookmark-default-annotation-text, bookmark-send-edited-annotation,
bookmark-relocate, bookmark-insert-location, bookmark-insert,
bookmark-delete):
Rename `bookmark' parameter to `bookmark-name', and in some cases
shorten doc string accordingly.
(bookmark-rename):
Change `old' and `new' parameters to `old-name'
and `new-name', and adjust an internal variable to avoid confusion.
(bookmark-jump, bookmark-jump-noselect):
Clarify `bookmark' parameter in doc string.
modified:
lisp/ChangeLog changelog-20091113204419-o5vbwnq5f7feedwu-1432
lisp/bookmark.el bookmark.el-20091113204419-o5vbwnq5f7feedwu-621
------------------------------------------------------------
- bug#7548: 23.2.90; bookmark-default-handler wrong documentation, Leo, 2010/12/04
- bug#7548: 23.2.90; bookmark-default-handler wrong documentation, Leo, 2010/12/05
- bug#7548: [FIXED] bookmark-default-handler wrong documentation,
Karl Fogel <=
- bug#7548: [FIXED] bookmark-default-handler wrong documentation, Leo, 2010/12/10
- bug#7548: [FIXED] bookmark-default-handler wrong documentation, Karl Fogel, 2010/12/12
- bug#7548: [FIXED] bookmark-default-handler wrong documentation, Eli Zaretskii, 2010/12/12
- bug#7548: [FIXED] bookmark-default-handler wrong documentation, Karl Fogel, 2010/12/12
- bug#7548: [FIXED] bookmark-default-handler wrong documentation, Eli Zaretskii, 2010/12/12
- bug#7548: [FIXED] bookmark-default-handler wrong documentation, Eli Zaretskii, 2010/12/12
- bug#7548: [FIXED] bookmark-default-handler wrong documentation, Glenn Morris, 2010/12/12
- bug#7548: [FIXED] bookmark-default-handler wrong documentation, Glenn Morris, 2010/12/12
- bug#7548: [FIXED] bookmark-default-handler wrong documentation, Stefan Monnier, 2010/12/13