Skip to content

Commit 9841aac

Browse files
feat: Adds description to OAS spec for docs about delta_x, delta_y
1 parent 0735b45 commit 9841aac

File tree

4 files changed

+26
-10
lines changed

4 files changed

+26
-10
lines changed

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 103
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-95bb1cbe27cbed0339067fa133590e675b99cda4a9c04fad802a5b14563eb572.yml
3-
openapi_spec_hash: 3a24e61711eedb9ea7bb7589a7df956f
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel%2Fkernel-aa981bcc44bf8382844c53b705f75eeac53fdc7cd828a9260755c5b4537ed966.yml
3+
openapi_spec_hash: e78521a8956dc87b25c076e30600a95e
44
config_hash: cff4d43372b6fa66b64e2d4150f6aa76

src/kernel/resources/browsers/computer.py

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -486,9 +486,11 @@ def scroll(
486486
487487
y: Y coordinate at which to perform the scroll
488488
489-
delta_x: Horizontal scroll amount. Positive scrolls right, negative scrolls left.
489+
delta_x: Horizontal scroll amount in xdotool "wheel units." Positive scrolls right,
490+
negative scrolls left.
490491
491-
delta_y: Vertical scroll amount. Positive scrolls down, negative scrolls up.
492+
delta_y: Vertical scroll amount in xdotool "wheel units." Positive scrolls down, negative
493+
scrolls up.
492494
493495
hold_keys: Modifier keys to hold during the scroll
494496
@@ -1087,9 +1089,11 @@ async def scroll(
10871089
10881090
y: Y coordinate at which to perform the scroll
10891091
1090-
delta_x: Horizontal scroll amount. Positive scrolls right, negative scrolls left.
1092+
delta_x: Horizontal scroll amount in xdotool "wheel units." Positive scrolls right,
1093+
negative scrolls left.
10911094
1092-
delta_y: Vertical scroll amount. Positive scrolls down, negative scrolls up.
1095+
delta_y: Vertical scroll amount in xdotool "wheel units." Positive scrolls down, negative
1096+
scrolls up.
10931097
10941098
hold_keys: Modifier keys to hold during the scroll
10951099

src/kernel/types/browsers/computer_batch_params.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,10 +131,16 @@ class ActionScroll(TypedDict, total=False):
131131
"""Y coordinate at which to perform the scroll"""
132132

133133
delta_x: int
134-
"""Horizontal scroll amount. Positive scrolls right, negative scrolls left."""
134+
"""
135+
Horizontal scroll amount in xdotool "wheel units." Positive scrolls right,
136+
negative scrolls left.
137+
"""
135138

136139
delta_y: int
137-
"""Vertical scroll amount. Positive scrolls down, negative scrolls up."""
140+
"""
141+
Vertical scroll amount in xdotool "wheel units." Positive scrolls down, negative
142+
scrolls up.
143+
"""
138144

139145
hold_keys: SequenceNotStr[str]
140146
"""Modifier keys to hold during the scroll"""

src/kernel/types/browsers/computer_scroll_params.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,16 @@ class ComputerScrollParams(TypedDict, total=False):
1717
"""Y coordinate at which to perform the scroll"""
1818

1919
delta_x: int
20-
"""Horizontal scroll amount. Positive scrolls right, negative scrolls left."""
20+
"""
21+
Horizontal scroll amount in xdotool "wheel units." Positive scrolls right,
22+
negative scrolls left.
23+
"""
2124

2225
delta_y: int
23-
"""Vertical scroll amount. Positive scrolls down, negative scrolls up."""
26+
"""
27+
Vertical scroll amount in xdotool "wheel units." Positive scrolls down, negative
28+
scrolls up.
29+
"""
2430

2531
hold_keys: SequenceNotStr[str]
2632
"""Modifier keys to hold during the scroll"""

0 commit comments

Comments
 (0)