Skip to content

Commit 30802b8

Browse files
committed
docs
1 parent a1fd054 commit 30802b8

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

src/textual/pilot.py

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -155,12 +155,12 @@ async def mouse_up(
155155
the offset specified and it must be within the visible area of the screen.
156156
157157
Args:
158-
widget: A widget or selector to be used as the reference
158+
widget: A widget or selector used as an origin
159159
for the event offset. If this is not specified, the offset is interpreted
160160
relative to the screen. You can use this parameter to try to target a
161161
specific widget. However, if the widget is currently hidden or obscured by
162162
another widget, the event may not land on the widget you specified.
163-
offset: The offset for the event. The offset is relative to the selector
163+
offset: The offset for the event. The offset is relative to the widget / selector
164164
provided or to the screen, if no selector is provided.
165165
shift: Simulate the event with the shift key held down.
166166
meta: Simulate the event with the meta key held down.
@@ -207,12 +207,12 @@ async def click(
207207
```
208208
209209
Args:
210-
widget: A widget or selector to specify the widget used as the reference
210+
widget: A widget or selector used as an origin
211211
for the click offset. If this is not specified, the offset is interpreted
212212
relative to the screen. You can use this parameter to try to click on a
213213
specific widget. However, if the widget is currently hidden or obscured by
214214
another widget, the click may not land on the widget you specified.
215-
offset: The offset to click. The offset is relative to the selector provided
215+
offset: The offset to click. The offset is relative to the widget / selector provided
216216
or to the screen, if no selector is provided.
217217
shift: Click with the shift key held down.
218218
meta: Click with the meta key held down.
@@ -249,12 +249,12 @@ async def hover(
249249
the offset specified and it must be within the visible area of the screen.
250250
251251
Args:
252-
selector: A selector to specify a widget that should be used as the reference
252+
selector: A widget or selector used as an origin
253253
for the hover offset. If this is not specified, the offset is interpreted
254254
relative to the screen. You can use this parameter to try to hover a
255255
specific widget. However, if the widget is currently hidden or obscured by
256256
another widget, the hover may not land on the widget you specified.
257-
offset: The offset to hover. The offset is relative to the selector provided
257+
offset: The offset to hover. The offset is relative to the widget / selector provided
258258
or to the screen, if no selector is provided.
259259
260260
Raises:
@@ -296,7 +296,7 @@ async def _post_mouse_events(
296296
relative to the screen. You can use this parameter to try to target a
297297
specific widget. However, if the widget is currently hidden or obscured by
298298
another widget, the events may not land on the widget you specified.
299-
offset: The offset for the events. The offset is relative to the selector
299+
offset: The offset for the events. The offset is relative to the widget / selector
300300
provided or to the screen, if no selector is provided.
301301
shift: Simulate the events with the shift key held down.
302302
meta: Simulate the events with the meta key held down.
@@ -311,6 +311,7 @@ async def _post_mouse_events(
311311
"""
312312
app = self.app
313313
screen = app.screen
314+
target_widget: Widget
314315
if widget is None:
315316
target_widget = screen
316317
elif isinstance(widget, Widget):

0 commit comments

Comments
 (0)