Skip to content

Commit 9f73b88

Browse files
authored
chore: render deprecated method parameters (microsoft#1913)
1 parent 3058517 commit 9f73b88

File tree

3 files changed

+16
-0
lines changed

3 files changed

+16
-0
lines changed

playwright/async_api/_generated.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4021,6 +4021,7 @@ async def is_hidden(
40214021
When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
40224022
element, the call throws an exception.
40234023
timeout : Union[float, None]
4024+
Deprecated: This option is ignored. `frame.is_hidden()` does not wait for the element to become hidden and returns immediately.
40244025

40254026
Returns
40264027
-------
@@ -4054,6 +4055,7 @@ async def is_visible(
40544055
When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
40554056
element, the call throws an exception.
40564057
timeout : Union[float, None]
4058+
Deprecated: This option is ignored. `frame.is_visible()` does not wait for the element to become visible and returns immediately.
40574059

40584060
Returns
40594061
-------
@@ -8425,6 +8427,7 @@ async def is_hidden(
84258427
When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
84268428
element, the call throws an exception.
84278429
timeout : Union[float, None]
8430+
Deprecated: This option is ignored. `page.is_hidden()` does not wait for the↵element to become hidden and returns immediately.
84288431

84298432
Returns
84308433
-------
@@ -8458,6 +8461,7 @@ async def is_visible(
84588461
When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
84598462
element, the call throws an exception.
84608463
timeout : Union[float, None]
8464+
Deprecated: This option is ignored. `page.is_visible()` does not wait↵for the element to become visible and returns immediately.
84618465

84628466
Returns
84638467
-------
@@ -17047,6 +17051,7 @@ async def is_hidden(self, *, timeout: typing.Optional[float] = None) -> bool:
1704717051
Parameters
1704817052
----------
1704917053
timeout : Union[float, None]
17054+
Deprecated: This option is ignored. `locator.is_hidden()` does not wait for the element to become hidden and returns immediately.
1705017055

1705117056
Returns
1705217057
-------
@@ -17073,6 +17078,7 @@ async def is_visible(self, *, timeout: typing.Optional[float] = None) -> bool:
1707317078
Parameters
1707417079
----------
1707517080
timeout : Union[float, None]
17081+
Deprecated: This option is ignored. `locator.is_visible()` does not wait for the element to become visible and returns immediately.
1707617082

1707717083
Returns
1707817084
-------

playwright/sync_api/_generated.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4087,6 +4087,7 @@ def is_hidden(
40874087
When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
40884088
element, the call throws an exception.
40894089
timeout : Union[float, None]
4090+
Deprecated: This option is ignored. `frame.is_hidden()` does not wait for the element to become hidden and returns immediately.
40904091

40914092
Returns
40924093
-------
@@ -4122,6 +4123,7 @@ def is_visible(
41224123
When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
41234124
element, the call throws an exception.
41244125
timeout : Union[float, None]
4126+
Deprecated: This option is ignored. `frame.is_visible()` does not wait for the element to become visible and returns immediately.
41254127

41264128
Returns
41274129
-------
@@ -8455,6 +8457,7 @@ def is_hidden(
84558457
When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
84568458
element, the call throws an exception.
84578459
timeout : Union[float, None]
8460+
Deprecated: This option is ignored. `page.is_hidden()` does not wait for the↵element to become hidden and returns immediately.
84588461

84598462
Returns
84608463
-------
@@ -8490,6 +8493,7 @@ def is_visible(
84908493
When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
84918494
element, the call throws an exception.
84928495
timeout : Union[float, None]
8496+
Deprecated: This option is ignored. `page.is_visible()` does not wait↵for the element to become visible and returns immediately.
84938497

84948498
Returns
84958499
-------
@@ -17171,6 +17175,7 @@ def is_hidden(self, *, timeout: typing.Optional[float] = None) -> bool:
1717117175
Parameters
1717217176
----------
1717317177
timeout : Union[float, None]
17178+
Deprecated: This option is ignored. `locator.is_hidden()` does not wait for the element to become hidden and returns immediately.
1717417179

1717517180
Returns
1717617181
-------
@@ -17199,6 +17204,7 @@ def is_visible(self, *, timeout: typing.Optional[float] = None) -> bool:
1719917204
Parameters
1720017205
----------
1720117206
timeout : Union[float, None]
17207+
Deprecated: This option is ignored. `locator.is_visible()` does not wait for the element to become visible and returns immediately.
1720217208

1720317209
Returns
1720417210
-------

scripts/documentation_provider.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,10 @@ def print_entry(
179179
print(
180180
f"{indent} {self.indent_paragraph(self.render_links(doc_value['comment']), f'{indent} ')}"
181181
)
182+
if doc_value.get("deprecated"):
183+
print(
184+
f"{indent} Deprecated: {self.render_links(doc_value['deprecated'])}"
185+
)
182186
self.compare_types(code_type, doc_value, f"{fqname}({name}=)", "in")
183187
if (
184188
signature

0 commit comments

Comments
 (0)