summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2018-04-01 12:09:54 +0300
committerEli Zaretskii <eliz@gnu.org>2018-04-01 12:09:54 +0300
commitaf1624f29bc264fe0cff31c46b25b0b0c90e24bf (patch)
treec1ad013b30ad7ff7d9120d26ee7f0b4c20c59525
parent3a451bd1e068092442f253291df643b0c02fee2d (diff)
downloademacs-af1624f29bc264fe0cff31c46b25b0b0c90e24bf.tar.gz
* lisp/net/shr.el (shr-browse-url): Doc fix. (Bug#30957)
-rw-r--r--lisp/net/shr.el8
1 files changed, 6 insertions, 2 deletions
diff --git a/lisp/net/shr.el b/lisp/net/shr.el
index a6b8693dd74..5582e29c526 100644
--- a/lisp/net/shr.el
+++ b/lisp/net/shr.el
@@ -934,8 +934,12 @@ size, and full-buffer size."
(shr-browse-url))
(defun shr-browse-url (&optional external mouse-event)
- "Browse the URL under point.
-If EXTERNAL, browse the URL using `shr-external-browser'."
+ "Browse the URL at point using `browse-url'.
+If EXTERNAL is non-nil (interactively, the prefix argument), browse
+the URL using `shr-external-browser'.
+If this function is invoked by a mouse click, it will browse the URL
+at the position of the click. Optional argument MOUSE-EVENT describes
+the mouse click event."
(interactive (list current-prefix-arg last-nonmenu-event))
(mouse-set-point mouse-event)
(let ((url (get-text-property (point) 'shr-url)))