; More accurate doc strings for 'window-at' and 'window-at-x-y'.

* lisp/window.el (window-at-x-y):
* src/window.c (Fwindow_at): Doc fix.  (Bug#61948)

diff --git a/lisp/window.el b/lisp/window.el
index 083fa9bfd2f616012951e98271d85b9a816dc600..f6ddae854ad7233cbe6204f32df4eee175040ddd 100644 (file)
--- a/lisp/window.el
+++ b/lisp/window.el
@@ -4134,6 +4134,10 @@ X and Y are FRAME-relative pixel coordinates.  A coordinate on an
 edge shared by two windows is attributed to the window on the
 right (or below).  Return nil if no such window can be found.
 
+Tool-bar and tab-bar pseudo-windows are ignored by this function:
+if the specified coordinates are in any of these two windows, this
+function returns nil.
+
 Optional argument FRAME must specify a live frame and defaults to
 the selected one.  Optional argument NO-OTHER non-nil means to
 return nil if the window located at the specified coordinates has

diff --git a/src/window.c b/src/window.c
index a94e1d611c78705bd8fbc76c74bb36b5c051b8c1..0efd6813f8d253d07d16b97dfa9312c6057f5361 100644 (file)
--- a/src/window.c
+++ b/src/window.c
@@ -1729,8 +1729,11 @@ window_from_coordinates (struct frame *f, int x, int y,
 DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
        doc: /* Return window containing coordinates X and Y on FRAME.
 FRAME must be a live frame and defaults to the selected one.
-The top left corner of the frame is considered to be row 0,
-column 0.  */)
+X and Y are measured in units of canonical columns and rows.
+The top left corner of the frame is considered to be column 0, row 0.
+Tool-bar and tab-bar pseudo-windows are ignored by this function: if
+the specified coordinates are in any of these two windows, this
+function returns nil.  */)
   (Lisp_Object x, Lisp_Object y, Lisp_Object frame)
 {
   struct frame *f = decode_live_frame (frame);