Skip to content

Commit acdfb41

Browse files
committed
Docs: Convert mouse_scroll params to regular paragraphs
1 parent a8cb9c1 commit acdfb41

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

ahkpy/mouse.py

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -158,18 +158,17 @@ def mouse_scroll(direction: str, times=1, *, modifier: str = None, blind=True, m
158158
159159
Scroll the mouse wheel.
160160
161-
:param str direction: the scroll direction. Takes one of the following
162-
values: ``"up"``, ``"down"``, ``"left"``, ``"right"``.
161+
The *direction* argument specifies the scroll direction. Takes one of the
162+
following values: ``"up"``, ``"down"``, ``"left"``, ``"right"``.
163163
164-
:param int times: the number of notches to turn the wheel. However, some
165-
applications do not obey *times* higher than 1. Use the following
166-
workaround::
164+
The *times* argument specifies the number of notches to turn the wheel.
165+
However, some applications do not obey *times* higher than 1. Use the
166+
following workaround::
167167
168-
for _ in range(5):
169-
ahkpy.mouse_scroll("up")
168+
for _ in range(5):
169+
ahkpy.mouse_scroll("up")
170170
171-
:param options: the optional keyword-only arguments that :func:`click`
172-
takes.
171+
For the *options* arguments refer to :func:`click`.
173172
174173
:command: `Send, {Click}
175174
<https://www.autohotkey.com/docs/commands/Send.htm#Click>`_
@@ -334,7 +333,7 @@ def get_cursor_type() -> str:
334333
Wait, Unknown.
335334
336335
The acronyms used with the size-type cursors are compass directions, e.g.
337-
NESW = NorthEast+SouthWest. The hand-shaped cursors (pointing and grabbing)
336+
NESW is NorthEast+SouthWest. The hand-shaped cursors (pointing and grabbing)
338337
are classified as Unknown.
339338
"""
340339
return ahk_call("GetVar", "A_Cursor")

0 commit comments

Comments
 (0)