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 64ee796a681f5c04d178acab08835c569ff75ab6..27f2acbc76a896e1ee1a9c49edb24f8fbdbd74f0 100644 (file)
--- 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.