From 12a6d319dcff5f1954f926be979b81170df2806c Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Thu, 3 Feb 2022 22:16:14 +0100 Subject: [PATCH] Improve the bookmark-default-handler doc string * lisp/bookmark.el (bookmark-default-handler): Document the `buffer' property (bug#20845). --- lisp/bookmark.el | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/lisp/bookmark.el b/lisp/bookmark.el index 0279d5ea83a..87533268812 100644 --- a/lisp/bookmark.el +++ b/lisp/bookmark.el @@ -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)) -- 2.39.5