summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefan Kangas <stefankangas@gmail.com>2019-07-02 07:09:13 +0200
committerEli Zaretskii <eliz@gnu.org>2019-07-06 11:54:55 +0300
commit43d2a0a4a8092d675bc9c5412f0bf71f78b1f97f (patch)
tree1482c85cb8dbc95b4d7a34a9988cd4bd274681f6
parent4436bd30aed4b1a0c64f94321e48bb1c174ccc4b (diff)
downloademacs-43d2a0a4a8092d675bc9c5412f0bf71f78b1f97f.tar.gz
* lisp/bookmark.el (bookmark-set-internal): Doc fix. (Bug#25032)
-rw-r--r--lisp/bookmark.el29
1 files changed, 17 insertions, 12 deletions
diff --git a/lisp/bookmark.el b/lisp/bookmark.el
index d4a54895aa0..4f908313ccf 100644
--- a/lisp/bookmark.el
+++ b/lisp/bookmark.el
@@ -746,18 +746,23 @@ CODING is the symbol of the coding-system in which the file is encoded."
map))
(defun bookmark-set-internal (prompt name overwrite-or-push)
- "Interactively set a bookmark named NAME at the current location.
-
-Begin the interactive prompt with PROMPT, followed by a space, a
-generated default name in parentheses, a colon and a space.
-
-If OVERWRITE-OR-PUSH is nil, then error if there is already a
-bookmark named NAME; if `overwrite', then replace any existing
-bookmark if there is one; if `push' then push the new bookmark
-onto the bookmark alist. The `push' behavior means that among
-bookmarks named NAME, this most recently set one becomes the one in
-effect, but the others are still there, in order, if the topmost one
-is ever deleted."
+ "Set a bookmark using specified NAME or prompting with PROMPT.
+The bookmark is set at the current location.
+
+If NAME is non-nil, use it as the name of the new bookmark. In
+this case, the value of PROMPT is ignored.
+
+Otherwise, prompt the user for the bookmark name. Begin the
+interactive prompt with PROMPT, followed by a space, a generated
+default name in parentheses, a colon and a space.
+
+OVERWRITE-OR-PUSH controls what happens if there is already a
+bookmark with the same name: nil means signal an error;
+`overwrite' means replace any existing bookmark; `push' means
+push the new bookmark onto the bookmark alist. The `push'
+behavior means that among bookmarks with the same name, this most
+recently set one becomes the one in effect, but the others are
+still there, in order, if the topmost one is ever deleted."
(unwind-protect
(let* ((record (bookmark-make-record))
;; `defaults' is a transient element of the