]> git.eshelyaron.com Git - emacs.git/commitdiff
Improve the bookmark-default-handler doc string
authorLars Ingebrigtsen <larsi@gnus.org>
Thu, 3 Feb 2022 21:16:14 +0000 (22:16 +0100)
committerLars Ingebrigtsen <larsi@gnus.org>
Thu, 3 Feb 2022 21:16:14 +0000 (22:16 +0100)
* lisp/bookmark.el (bookmark-default-handler): Document the
`buffer' property (bug#20845).

lisp/bookmark.el

index 0279d5ea83aabdca46056988c5b3586750d1cc68..87533268812f6dd1b4d90ec212a0a5ad130b8c30 100644 (file)
@@ -1274,7 +1274,10 @@ then offer interactively to relocate BOOKMARK-NAME-OR-RECORD."
 (defun bookmark-default-handler (bmk-record)
   "Default handler to jump to a particular bookmark location.
 BMK-RECORD is a bookmark record, not a bookmark name (i.e., not a string).
-Changes current buffer and point and returns nil, or signals a `file-error'."
+Changes current buffer and point and returns nil, or signals a `file-error'.
+
+If BMK-RECORD has a property called `buffer', it should be a live
+buffer object, and this buffer will be selected."
   (let ((file          (bookmark-get-filename bmk-record))
        (buf           (bookmark-prop-get bmk-record 'buffer))
         (forward-str   (bookmark-get-front-context-string bmk-record))