Skip to content

Commit 1c6a93b

Browse files
mehaasemehaase
committed
Regenerate docs
1 parent 532d833 commit 1c6a93b

44 files changed

Lines changed: 708 additions & 44 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/api/accessibility.rst‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,10 @@ Accessibility
1212
Types
1313
-----
1414

15-
Generally you do not need to instantiate CDP types yourself. Instead, the API creates objects for you as return values from commands, and then you can use those objects as arguments to other commands.
15+
Generally, you do not need to instantiate CDP types
16+
yourself. Instead, the API creates objects for you as return
17+
values from commands, and then you can use those objects as
18+
arguments to other commands.
1619

1720
.. autoclass:: AXNodeId
1821
:members:
@@ -67,6 +70,15 @@ Generally you do not need to instantiate CDP types yourself. Instead, the API cr
6770
Commands
6871
--------
6972

73+
Each command is a generator function. The return
74+
type ``Generator[x, y, z]`` indicates that the generator
75+
*yields* arguments of type ``x``, it must be resumed with
76+
an argument of type ``y``, and it returns type ``z``. In
77+
this library, types ``x`` and ``y`` are the same for all
78+
commands, and ``z`` is the return type you should pay attention
79+
to. For more information, see
80+
:ref:`Getting Started: Commands <getting-started-commands>`.
81+
7082
.. autofunction:: disable
7183

7284
.. autofunction:: enable
@@ -77,3 +89,5 @@ Commands
7789

7890
Events
7991
------
92+
93+
*There are no events in this module.*

‎docs/api/animation.rst‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,10 @@ Animation
1212
Types
1313
-----
1414

15-
Generally you do not need to instantiate CDP types yourself. Instead, the API creates objects for you as return values from commands, and then you can use those objects as arguments to other commands.
15+
Generally, you do not need to instantiate CDP types
16+
yourself. Instead, the API creates objects for you as return
17+
values from commands, and then you can use those objects as
18+
arguments to other commands.
1619

1720
.. autoclass:: Animation
1821
:members:
@@ -37,6 +40,15 @@ Generally you do not need to instantiate CDP types yourself. Instead, the API cr
3740
Commands
3841
--------
3942

43+
Each command is a generator function. The return
44+
type ``Generator[x, y, z]`` indicates that the generator
45+
*yields* arguments of type ``x``, it must be resumed with
46+
an argument of type ``y``, and it returns type ``z``. In
47+
this library, types ``x`` and ``y`` are the same for all
48+
commands, and ``z`` is the return type you should pay attention
49+
to. For more information, see
50+
:ref:`Getting Started: Commands <getting-started-commands>`.
51+
4052
.. autofunction:: disable
4153

4254
.. autofunction:: enable
@@ -60,6 +72,10 @@ Commands
6072
Events
6173
------
6274

75+
Generally, you do not need to instantiate CDP events
76+
yourself. Instead, the API creates events for you and then
77+
you use the event's attributes.
78+
6379
.. autoclass:: AnimationCanceled
6480
:members:
6581
:undoc-members:

‎docs/api/application_cache.rst‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,10 @@ ApplicationCache
1212
Types
1313
-----
1414

15-
Generally you do not need to instantiate CDP types yourself. Instead, the API creates objects for you as return values from commands, and then you can use those objects as arguments to other commands.
15+
Generally, you do not need to instantiate CDP types
16+
yourself. Instead, the API creates objects for you as return
17+
values from commands, and then you can use those objects as
18+
arguments to other commands.
1619

1720
.. autoclass:: ApplicationCacheResource
1821
:members:
@@ -32,6 +35,15 @@ Generally you do not need to instantiate CDP types yourself. Instead, the API cr
3235
Commands
3336
--------
3437

38+
Each command is a generator function. The return
39+
type ``Generator[x, y, z]`` indicates that the generator
40+
*yields* arguments of type ``x``, it must be resumed with
41+
an argument of type ``y``, and it returns type ``z``. In
42+
this library, types ``x`` and ``y`` are the same for all
43+
commands, and ``z`` is the return type you should pay attention
44+
to. For more information, see
45+
:ref:`Getting Started: Commands <getting-started-commands>`.
46+
3547
.. autofunction:: enable
3648

3749
.. autofunction:: get_application_cache_for_frame
@@ -43,6 +55,10 @@ Commands
4355
Events
4456
------
4557

58+
Generally, you do not need to instantiate CDP events
59+
yourself. Instead, the API creates events for you and then
60+
you use the event's attributes.
61+
4662
.. autoclass:: ApplicationCacheStatusUpdated
4763
:members:
4864
:undoc-members:

‎docs/api/audits.rst‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,23 @@ Audits domain allows investigation of page violations and possible improvements.
1414
Types
1515
-----
1616

17-
Generally you do not need to instantiate CDP types yourself. Instead, the API creates objects for you as return values from commands, and then you can use those objects as arguments to other commands.
17+
*There are no types in this module.*
1818

1919
Commands
2020
--------
2121

22+
Each command is a generator function. The return
23+
type ``Generator[x, y, z]`` indicates that the generator
24+
*yields* arguments of type ``x``, it must be resumed with
25+
an argument of type ``y``, and it returns type ``z``. In
26+
this library, types ``x`` and ``y`` are the same for all
27+
commands, and ``z`` is the return type you should pay attention
28+
to. For more information, see
29+
:ref:`Getting Started: Commands <getting-started-commands>`.
30+
2231
.. autofunction:: get_encoded_response
2332

2433
Events
2534
------
35+
36+
*There are no events in this module.*

‎docs/api/background_service.rst‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,10 @@ Defines events for background web platform features.
1414
Types
1515
-----
1616

17-
Generally you do not need to instantiate CDP types yourself. Instead, the API creates objects for you as return values from commands, and then you can use those objects as arguments to other commands.
17+
Generally, you do not need to instantiate CDP types
18+
yourself. Instead, the API creates objects for you as return
19+
values from commands, and then you can use those objects as
20+
arguments to other commands.
1821

1922
.. autoclass:: ServiceName
2023
:members:
@@ -34,6 +37,15 @@ Generally you do not need to instantiate CDP types yourself. Instead, the API cr
3437
Commands
3538
--------
3639

40+
Each command is a generator function. The return
41+
type ``Generator[x, y, z]`` indicates that the generator
42+
*yields* arguments of type ``x``, it must be resumed with
43+
an argument of type ``y``, and it returns type ``z``. In
44+
this library, types ``x`` and ``y`` are the same for all
45+
commands, and ``z`` is the return type you should pay attention
46+
to. For more information, see
47+
:ref:`Getting Started: Commands <getting-started-commands>`.
48+
3749
.. autofunction:: clear_events
3850

3951
.. autofunction:: set_recording
@@ -45,6 +57,10 @@ Commands
4557
Events
4658
------
4759

60+
Generally, you do not need to instantiate CDP events
61+
yourself. Instead, the API creates events for you and then
62+
you use the event's attributes.
63+
4864
.. autoclass:: RecordingStateChanged
4965
:members:
5066
:undoc-members:

‎docs/api/browser.rst‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,10 @@ The Browser domain defines methods and events for browser managing.
1212
Types
1313
-----
1414

15-
Generally you do not need to instantiate CDP types yourself. Instead, the API creates objects for you as return values from commands, and then you can use those objects as arguments to other commands.
15+
Generally, you do not need to instantiate CDP types
16+
yourself. Instead, the API creates objects for you as return
17+
values from commands, and then you can use those objects as
18+
arguments to other commands.
1619

1720
.. autoclass:: WindowID
1821
:members:
@@ -47,6 +50,15 @@ Generally you do not need to instantiate CDP types yourself. Instead, the API cr
4750
Commands
4851
--------
4952

53+
Each command is a generator function. The return
54+
type ``Generator[x, y, z]`` indicates that the generator
55+
*yields* arguments of type ``x``, it must be resumed with
56+
an argument of type ``y``, and it returns type ``z``. In
57+
this library, types ``x`` and ``y`` are the same for all
58+
commands, and ``z`` is the return type you should pay attention
59+
to. For more information, see
60+
:ref:`Getting Started: Commands <getting-started-commands>`.
61+
5062
.. autofunction:: close
5163

5264
.. autofunction:: crash
@@ -75,3 +87,5 @@ Commands
7587

7688
Events
7789
------
90+
91+
*There are no events in this module.*

‎docs/api/cache_storage.rst‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,10 @@ CacheStorage
1212
Types
1313
-----
1414

15-
Generally you do not need to instantiate CDP types yourself. Instead, the API creates objects for you as return values from commands, and then you can use those objects as arguments to other commands.
15+
Generally, you do not need to instantiate CDP types
16+
yourself. Instead, the API creates objects for you as return
17+
values from commands, and then you can use those objects as
18+
arguments to other commands.
1619

1720
.. autoclass:: CacheId
1821
:members:
@@ -47,6 +50,15 @@ Generally you do not need to instantiate CDP types yourself. Instead, the API cr
4750
Commands
4851
--------
4952

53+
Each command is a generator function. The return
54+
type ``Generator[x, y, z]`` indicates that the generator
55+
*yields* arguments of type ``x``, it must be resumed with
56+
an argument of type ``y``, and it returns type ``z``. In
57+
this library, types ``x`` and ``y`` are the same for all
58+
commands, and ``z`` is the return type you should pay attention
59+
to. For more information, see
60+
:ref:`Getting Started: Commands <getting-started-commands>`.
61+
5062
.. autofunction:: delete_cache
5163

5264
.. autofunction:: delete_entry
@@ -59,3 +71,5 @@ Commands
5971

6072
Events
6173
------
74+
75+
*There are no events in this module.*

‎docs/api/cast.rst‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,10 @@ functionalities.
1515
Types
1616
-----
1717

18-
Generally you do not need to instantiate CDP types yourself. Instead, the API creates objects for you as return values from commands, and then you can use those objects as arguments to other commands.
18+
Generally, you do not need to instantiate CDP types
19+
yourself. Instead, the API creates objects for you as return
20+
values from commands, and then you can use those objects as
21+
arguments to other commands.
1922

2023
.. autoclass:: Sink
2124
:members:
@@ -25,6 +28,15 @@ Generally you do not need to instantiate CDP types yourself. Instead, the API cr
2528
Commands
2629
--------
2730

31+
Each command is a generator function. The return
32+
type ``Generator[x, y, z]`` indicates that the generator
33+
*yields* arguments of type ``x``, it must be resumed with
34+
an argument of type ``y``, and it returns type ``z``. In
35+
this library, types ``x`` and ``y`` are the same for all
36+
commands, and ``z`` is the return type you should pay attention
37+
to. For more information, see
38+
:ref:`Getting Started: Commands <getting-started-commands>`.
39+
2840
.. autofunction:: disable
2941

3042
.. autofunction:: enable
@@ -38,6 +50,10 @@ Commands
3850
Events
3951
------
4052

53+
Generally, you do not need to instantiate CDP events
54+
yourself. Instead, the API creates events for you and then
55+
you use the event's attributes.
56+
4157
.. autoclass:: SinksUpdated
4258
:members:
4359
:undoc-members:

‎docs/api/console.rst‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,10 @@ This domain is deprecated - use Runtime or Log instead.
1212
Types
1313
-----
1414

15-
Generally you do not need to instantiate CDP types yourself. Instead, the API creates objects for you as return values from commands, and then you can use those objects as arguments to other commands.
15+
Generally, you do not need to instantiate CDP types
16+
yourself. Instead, the API creates objects for you as return
17+
values from commands, and then you can use those objects as
18+
arguments to other commands.
1619

1720
.. autoclass:: ConsoleMessage
1821
:members:
@@ -22,6 +25,15 @@ Generally you do not need to instantiate CDP types yourself. Instead, the API cr
2225
Commands
2326
--------
2427

28+
Each command is a generator function. The return
29+
type ``Generator[x, y, z]`` indicates that the generator
30+
*yields* arguments of type ``x``, it must be resumed with
31+
an argument of type ``y``, and it returns type ``z``. In
32+
this library, types ``x`` and ``y`` are the same for all
33+
commands, and ``z`` is the return type you should pay attention
34+
to. For more information, see
35+
:ref:`Getting Started: Commands <getting-started-commands>`.
36+
2537
.. autofunction:: clear_messages
2638

2739
.. autofunction:: disable
@@ -31,6 +43,10 @@ Commands
3143
Events
3244
------
3345

46+
Generally, you do not need to instantiate CDP events
47+
yourself. Instead, the API creates events for you and then
48+
you use the event's attributes.
49+
3450
.. autoclass:: MessageAdded
3551
:members:
3652
:undoc-members:

‎docs/api/css.rst‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,10 @@ subsequently load the required stylesheet contents using the `getStyleSheet[Text
1919
Types
2020
-----
2121

22-
Generally you do not need to instantiate CDP types yourself. Instead, the API creates objects for you as return values from commands, and then you can use those objects as arguments to other commands.
22+
Generally, you do not need to instantiate CDP types
23+
yourself. Instead, the API creates objects for you as return
24+
values from commands, and then you can use those objects as
25+
arguments to other commands.
2326

2427
.. autoclass:: StyleSheetId
2528
:members:
@@ -139,6 +142,15 @@ Generally you do not need to instantiate CDP types yourself. Instead, the API cr
139142
Commands
140143
--------
141144

145+
Each command is a generator function. The return
146+
type ``Generator[x, y, z]`` indicates that the generator
147+
*yields* arguments of type ``x``, it must be resumed with
148+
an argument of type ``y``, and it returns type ``z``. In
149+
this library, types ``x`` and ``y`` are the same for all
150+
commands, and ``z`` is the return type you should pay attention
151+
to. For more information, see
152+
:ref:`Getting Started: Commands <getting-started-commands>`.
153+
142154
.. autofunction:: add_rule
143155

144156
.. autofunction:: collect_class_names
@@ -186,6 +198,10 @@ Commands
186198
Events
187199
------
188200

201+
Generally, you do not need to instantiate CDP events
202+
yourself. Instead, the API creates events for you and then
203+
you use the event's attributes.
204+
189205
.. autoclass:: FontsUpdated
190206
:members:
191207
:undoc-members:

0 commit comments

Comments
 (0)