chore: render deprecated method parameters (microsoft#1913)

mxschmitt · web-flow · commit 9f73b8844bb8 · 2023-05-11T08:51:03.000-07:00
diff --git a/playwright/async_api/_generated.py b/playwright/async_api/_generated.py
@@ -4021,6 +4021,7 @@ async def is_hidden(
             When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
             element, the call throws an exception.
         timeout : Union[float, None]
+            Deprecated: This option is ignored. `frame.is_hidden()` does not wait for the element to become hidden and returns immediately.
 
         Returns
         -------
@@ -4054,6 +4055,7 @@ async def is_visible(
             When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
             element, the call throws an exception.
         timeout : Union[float, None]
+            Deprecated: This option is ignored. `frame.is_visible()` does not wait for the element to become visible and returns immediately.
 
         Returns
         -------
@@ -8425,6 +8427,7 @@ async def is_hidden(
             When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
             element, the call throws an exception.
         timeout : Union[float, None]
+            Deprecated: This option is ignored. `page.is_hidden()` does not wait for the↵element to become hidden and returns immediately.
 
         Returns
         -------
@@ -8458,6 +8461,7 @@ async def is_visible(
             When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
             element, the call throws an exception.
         timeout : Union[float, None]
+            Deprecated: This option is ignored. `page.is_visible()` does not wait↵for the element to become visible and returns immediately.
 
         Returns
         -------
@@ -17047,6 +17051,7 @@ async def is_hidden(self, *, timeout: typing.Optional[float] = None) -> bool:
         Parameters
         ----------
         timeout : Union[float, None]
+            Deprecated: This option is ignored. `locator.is_hidden()` does not wait for the element to become hidden and returns immediately.
 
         Returns
         -------
@@ -17073,6 +17078,7 @@ async def is_visible(self, *, timeout: typing.Optional[float] = None) -> bool:
         Parameters
         ----------
         timeout : Union[float, None]
+            Deprecated: This option is ignored. `locator.is_visible()` does not wait for the element to become visible and returns immediately.
 
         Returns
         -------
diff --git a/playwright/sync_api/_generated.py b/playwright/sync_api/_generated.py
@@ -4087,6 +4087,7 @@ def is_hidden(
             When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
             element, the call throws an exception.
         timeout : Union[float, None]
+            Deprecated: This option is ignored. `frame.is_hidden()` does not wait for the element to become hidden and returns immediately.
 
         Returns
         -------
@@ -4122,6 +4123,7 @@ def is_visible(
             When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
             element, the call throws an exception.
         timeout : Union[float, None]
+            Deprecated: This option is ignored. `frame.is_visible()` does not wait for the element to become visible and returns immediately.
 
         Returns
         -------
@@ -8455,6 +8457,7 @@ def is_hidden(
             When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
             element, the call throws an exception.
         timeout : Union[float, None]
+            Deprecated: This option is ignored. `page.is_hidden()` does not wait for the↵element to become hidden and returns immediately.
 
         Returns
         -------
@@ -8490,6 +8493,7 @@ def is_visible(
             When true, the call requires selector to resolve to a single element. If given selector resolves to more than one
             element, the call throws an exception.
         timeout : Union[float, None]
+            Deprecated: This option is ignored. `page.is_visible()` does not wait↵for the element to become visible and returns immediately.
 
         Returns
         -------
@@ -17171,6 +17175,7 @@ def is_hidden(self, *, timeout: typing.Optional[float] = None) -> bool:
         Parameters
         ----------
         timeout : Union[float, None]
+            Deprecated: This option is ignored. `locator.is_hidden()` does not wait for the element to become hidden and returns immediately.
 
         Returns
         -------
@@ -17199,6 +17204,7 @@ def is_visible(self, *, timeout: typing.Optional[float] = None) -> bool:
         Parameters
         ----------
         timeout : Union[float, None]
+            Deprecated: This option is ignored. `locator.is_visible()` does not wait for the element to become visible and returns immediately.
 
         Returns
         -------
diff --git a/scripts/documentation_provider.py b/scripts/documentation_provider.py
@@ -179,6 +179,10 @@ def print_entry(
                         print(
                             f"{indent}    {self.indent_paragraph(self.render_links(doc_value['comment']), f'{indent}    ')}"
                         )
+                    if doc_value.get("deprecated"):
+                        print(
+                            f"{indent}    Deprecated: {self.render_links(doc_value['deprecated'])}"
+                        )
                     self.compare_types(code_type, doc_value, f"{fqname}({name}=)", "in")
         if (
             signature
