From: Eli Zaretskii <eliz@gnu.org>
Date: Thu, 7 Jul 2016 16:15:03 +0000 (+0300)
Subject: Clarify documentation of 'mouse-on-link-p'
X-Git-Tag: emacs-25.1-rc1~37
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=c53135b;p=emacs.git

Clarify documentation of 'mouse-on-link-p'

* lisp/mouse.el (mouse-on-link-p): Clarify the form of the POS
argument.  (Bug#23899)
---

diff --git a/lisp/mouse.el b/lisp/mouse.el
index 64ee796a681..27f2acbc76a 100644
--- a/lisp/mouse.el
+++ b/lisp/mouse.el
@@ -718,8 +718,9 @@ its value is returned."
 
 (defun mouse-on-link-p (pos)
   "Return non-nil if POS is on a link in the current buffer.
-POS must be a buffer position in the current buffer or a mouse
-event location in the selected window (see `event-start').
+POS must specify a buffer position in the current buffer, as a list
+of the form returned by the `event-start' and `event-end' functions,
+or a mouse event location in the selected window (see `event-start').
 However, if `mouse-1-click-in-non-selected-windows' is non-nil,
 POS may be a mouse event location in any window.