]> git.eshelyaron.com Git - emacs.git/commitdiff
* lisp/net/shr.el (shr-browse-url): Doc fix. (Bug#30957)
authorEli Zaretskii <eliz@gnu.org>
Sun, 1 Apr 2018 09:09:54 +0000 (12:09 +0300)
committerEli Zaretskii <eliz@gnu.org>
Sun, 1 Apr 2018 09:09:54 +0000 (12:09 +0300)
lisp/net/shr.el

index a6b8693dd74c8da06df2b590697eec3ae428b3ae..5582e29c5266f02dff512cfad7382126cd41f6fc 100644 (file)
@@ -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)))