gdb/doc: improve description for Window.click on Python TUI windows
authorAndrew Burgess <aburgess@redhat.com>
Mon, 24 Jan 2022 10:33:23 +0000 (10:33 +0000)
committerAndrew Burgess <aburgess@redhat.com>
Mon, 24 Jan 2022 15:33:55 +0000 (15:33 +0000)
The description of the Window.click method doesn't mention where the
coordinates are anchored (it's the top left corner).

This minor tweak just mentions this point.

gdb/doc/python.texi

index 6730de05143465a7b943600811d8df37bc6d69ab..f02380a27f4ab1527e9f3e71c3e188cc4ee35c06 100644 (file)
@@ -6252,9 +6252,9 @@ and so the content should appear to move up.
 
 @defun Window.click (@var{x}, @var{y}, @var{button})
 This is called on a mouse click in this window.  @var{x} and @var{y} are
-the mouse coordinates inside the window (0-based), and @var{button}
-specifies which mouse button was used, whose values can be 1 (left),
-2 (middle), or 3 (right).
+the mouse coordinates inside the window (0-based, from the top left
+corner), and @var{button} specifies which mouse button was used, whose
+values can be 1 (left), 2 (middle), or 3 (right).
 @end defun
 
 @node Python Auto-loading