playwright-ruby-client 1.28.1 → 1.29.0

data/lib/playwright_api/frame.rb

@@ -1,13 +1,12 @@
 module Playwright
+  #
   # At every point of time, page exposes its current frame tree via the [`method: Page.mainFrame`] and
   # [`method: Frame.childFrames`] methods.
   #
   # `Frame` object's lifecycle is controlled by three events, dispatched on the page object:
-  # - [`event: Page.frameAttached`] - fired when the frame gets attached to the page. A Frame can be attached to the page
-  #   only once.
+  # - [`event: Page.frameAttached`] - fired when the frame gets attached to the page. A Frame can be attached to the page only once.
   # - [`event: Page.frameNavigated`] - fired when the frame commits navigation to a different URL.
-  # - [`event: Page.frameDetached`] - fired when the frame gets detached from the page.  A Frame can be detached from the
-  #   page only once.
+  # - [`event: Page.frameDetached`] - fired when the frame gets detached from the page.  A Frame can be detached from the page only once.
   #
   # An example of dumping frame tree:
   #
@@ -32,6 +31,7 @@ module Playwright
   # ```
   class Frame < PlaywrightApi
 
+    #
     # Returns the added tag when the script's onload fires or when the script content was injected into frame.
     #
     # Adds a `<script>` tag into the page with the desired url or content.
@@ -39,6 +39,7 @@ module Playwright
       wrap_impl(@impl.add_script_tag(content: unwrap_impl(content), path: unwrap_impl(path), type: unwrap_impl(type), url: unwrap_impl(url)))
     end
 
+    #
     # Returns the added tag when the stylesheet's onload fires or when the CSS content was injected into frame.
     #
     # Adds a `<link rel="stylesheet">` tag into the page with the desired url or a `<style type="text/css">` tag with the
@@ -47,19 +48,18 @@ module Playwright
       wrap_impl(@impl.add_style_tag(content: unwrap_impl(content), path: unwrap_impl(path), url: unwrap_impl(url)))
     end
 
+    #
     # This method checks an element matching `selector` by performing the following steps:
     # 1. Find an element matching `selector`. If there is none, wait until a matching element is attached to the DOM.
-    # 1. Ensure that matched element is a checkbox or a radio input. If not, this method throws. If the element is already
-    #    checked, this method returns immediately.
-    # 1. Wait for [actionability](../actionability.md) checks on the matched element, unless `force` option is set. If the
-    #    element is detached during the checks, the whole action is retried.
+    # 1. Ensure that matched element is a checkbox or a radio input. If not, this method throws. If the element is already checked, this method returns immediately.
+    # 1. Wait for [actionability](../actionability.md) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried.
     # 1. Scroll the element into view if needed.
     # 1. Use [`property: Page.mouse`] to click in the center of the element.
     # 1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set.
     # 1. Ensure that the element is now checked. If not, this method throws.
     #
-    # When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`. Passing
-    # zero timeout disables this.
+    # When all steps combined have not finished during the specified `timeout`, this method throws a
+    # `TimeoutError`. Passing zero timeout disables this.
     def check(
           selector,
           force: nil,
@@ -75,16 +75,16 @@ module Playwright
       wrap_impl(@impl.child_frames)
     end
 
+    #
     # This method clicks an element matching `selector` by performing the following steps:
     # 1. Find an element matching `selector`. If there is none, wait until a matching element is attached to the DOM.
-    # 1. Wait for [actionability](../actionability.md) checks on the matched element, unless `force` option is set. If the
-    #    element is detached during the checks, the whole action is retried.
+    # 1. Wait for [actionability](../actionability.md) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried.
     # 1. Scroll the element into view if needed.
     # 1. Use [`property: Page.mouse`] to click in the center of the element, or the specified `position`.
     # 1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set.
     #
-    # When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`. Passing
-    # zero timeout disables this.
+    # When all steps combined have not finished during the specified `timeout`, this method throws a
+    # `TimeoutError`. Passing zero timeout disables this.
     def click(
           selector,
           button: nil,
@@ -100,24 +100,24 @@ module Playwright
       wrap_impl(@impl.click(unwrap_impl(selector), button: unwrap_impl(button), clickCount: unwrap_impl(clickCount), delay: unwrap_impl(delay), force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
+    #
     # Gets the full HTML contents of the frame, including the doctype.
     def content
       wrap_impl(@impl.content)
     end
 
+    #
     # This method double clicks an element matching `selector` by performing the following steps:
     # 1. Find an element matching `selector`. If there is none, wait until a matching element is attached to the DOM.
-    # 1. Wait for [actionability](../actionability.md) checks on the matched element, unless `force` option is set. If the
-    #    element is detached during the checks, the whole action is retried.
+    # 1. Wait for [actionability](../actionability.md) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried.
     # 1. Scroll the element into view if needed.
     # 1. Use [`property: Page.mouse`] to double click in the center of the element, or the specified `position`.
-    # 1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. Note that if the
-    #    first click of the `dblclick()` triggers a navigation event, this method will throw.
+    # 1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. Note that if the first click of the `dblclick()` triggers a navigation event, this method will throw.
     #
-    # When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`. Passing
-    # zero timeout disables this.
+    # When all steps combined have not finished during the specified `timeout`, this method throws a
+    # `TimeoutError`. Passing zero timeout disables this.
     #
-    # > NOTE: `frame.dblclick()` dispatches two `click` events and a single `dblclick` event.
+    # **NOTE**: `frame.dblclick()` dispatches two `click` events and a single `dblclick` event.
     def dblclick(
           selector,
           button: nil,
@@ -132,18 +132,23 @@ module Playwright
       wrap_impl(@impl.dblclick(unwrap_impl(selector), button: unwrap_impl(button), delay: unwrap_impl(delay), force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
-    # The snippet below dispatches the `click` event on the element. Regardless of the visibility state of the element,
-    # `click` is dispatched. This is equivalent to calling
+    #
+    # The snippet below dispatches the `click` event on the element. Regardless of the visibility state of the element, `click`
+    # is dispatched. This is equivalent to calling
     # [element.click()](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/click).
     #
+    # **Usage**
+    #
     # ```python sync
     # frame.dispatch_event("button#submit", "click")
     # ```
     #
-    # Under the hood, it creates an instance of an event based on the given `type`, initializes it with `eventInit` properties
-    # and dispatches it on the element. Events are `composed`, `cancelable` and bubble by default.
+    # Under the hood, it creates an instance of an event based on the given `type`, initializes it with
+    # `eventInit` properties and dispatches it on the element. Events are `composed`, `cancelable` and bubble by
+    # default.
     #
-    # Since `eventInit` is event-specific, please refer to the events documentation for the lists of initial properties:
+    # Since `eventInit` is event-specific, please refer to the events documentation for the lists of initial
+    # properties:
     # - [DragEvent](https://developer.mozilla.org/en-US/docs/Web/API/DragEvent/DragEvent)
     # - [FocusEvent](https://developer.mozilla.org/en-US/docs/Web/API/FocusEvent/FocusEvent)
     # - [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/KeyboardEvent)
@@ -181,19 +186,17 @@ module Playwright
       wrap_impl(@impl.drag_and_drop(unwrap_impl(source), unwrap_impl(target), force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), sourcePosition: unwrap_impl(sourcePosition), strict: unwrap_impl(strict), targetPosition: unwrap_impl(targetPosition), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
-    # Returns the return value of `expression`.
     #
-    # > NOTE: This method does not wait for the element to pass actionability checks and therefore can lead to the flaky
-    # tests. Use [`method: Locator.evaluate`], other `Locator` helper methods or web-first assertions instead.
+    # Returns the return value of `expression`.
     #
     # The method finds an element matching the specified selector within the frame and passes it as a first argument to
-    # `expression`. See [Working with selectors](../selectors.md) for more details. If no elements match the selector, the
-    # method throws an error.
+    # `expression`. If no
+    # elements match the selector, the method throws an error.
     #
-    # If `expression` returns a [Promise], then [`method: Frame.evalOnSelector`] would wait for the promise to resolve and
-    # return its value.
+    # If `expression` returns a [Promise], then [`method: Frame.evalOnSelector`] would wait for the promise to resolve and return its
+    # value.
     #
-    # Examples:
+    # **Usage**
     #
     # ```python sync
     # search_value = frame.eval_on_selector("#search", "el => el.value")
@@ -204,18 +207,16 @@ module Playwright
       wrap_impl(@impl.eval_on_selector(unwrap_impl(selector), unwrap_impl(expression), arg: unwrap_impl(arg), strict: unwrap_impl(strict)))
     end
 
-    # Returns the return value of `expression`.
     #
-    # > NOTE: In most cases, [`method: Locator.evaluateAll`], other `Locator` helper methods and web-first assertions do a
-    # better job.
+    # Returns the return value of `expression`.
     #
     # The method finds all elements matching the specified selector within the frame and passes an array of matched elements
-    # as a first argument to `expression`. See [Working with selectors](../selectors.md) for more details.
+    # as a first argument to `expression`.
     #
-    # If `expression` returns a [Promise], then [`method: Frame.evalOnSelectorAll`] would wait for the promise to resolve and
-    # return its value.
+    # If `expression` returns a [Promise], then [`method: Frame.evalOnSelectorAll`] would wait for the promise to resolve and return its
+    # value.
     #
-    # Examples:
+    # **Usage**
     #
     # ```python sync
     # divs_counts = frame.eval_on_selector_all("div", "(divs, min) => divs.length >= min", 10)
@@ -224,14 +225,17 @@ module Playwright
       wrap_impl(@impl.eval_on_selector_all(unwrap_impl(selector), unwrap_impl(expression), arg: unwrap_impl(arg)))
     end
 
+    #
     # Returns the return value of `expression`.
     #
-    # If the function passed to the [`method: Frame.evaluate`] returns a [Promise], then [`method: Frame.evaluate`] would wait
-    # for the promise to resolve and return its value.
+    # If the function passed to the [`method: Frame.evaluate`] returns a [Promise], then [`method: Frame.evaluate`] would wait for the promise to
+    # resolve and return its value.
     #
     # If the function passed to the [`method: Frame.evaluate`] returns a non-[Serializable] value, then
-    # [`method: Frame.evaluate`] returns `undefined`. Playwright also supports transferring some additional values that are
-    # not serializable by `JSON`: `-0`, `NaN`, `Infinity`, `-Infinity`.
+    # [`method: Frame.evaluate`] returns `undefined`. Playwright also supports transferring some
+    # additional values that are not serializable by `JSON`: `-0`, `NaN`, `Infinity`, `-Infinity`.
+    #
+    # **Usage**
     #
     # ```python sync
     # result = frame.evaluate("([x, y]) => Promise.resolve(x * y)", [7, 8])
@@ -257,6 +261,7 @@ module Playwright
       wrap_impl(@impl.evaluate(unwrap_impl(expression), arg: unwrap_impl(arg)))
     end
 
+    #
     # Returns the return value of `expression` as a `JSHandle`.
     #
     # The only difference between [`method: Frame.evaluate`] and [`method: Frame.evaluateHandle`] is that
@@ -265,6 +270,8 @@ module Playwright
     # If the function, passed to the [`method: Frame.evaluateHandle`], returns a [Promise], then
     # [`method: Frame.evaluateHandle`] would wait for the promise to resolve and return its value.
     #
+    # **Usage**
+    #
     # ```python sync
     # a_window_handle = frame.evaluate_handle("Promise.resolve(window)")
     # a_window_handle # handle for the window object.
@@ -288,14 +295,10 @@ module Playwright
       wrap_impl(@impl.evaluate_handle(unwrap_impl(expression), arg: unwrap_impl(arg)))
     end
 
-    # This method waits for an element matching `selector`, waits for [actionability](../actionability.md) checks, focuses the
-    # element, fills it and triggers an `input` event after filling. Note that you can pass an empty string to clear the input
-    # field.
     #
-    # If the target element is not an `<input>`, `<textarea>` or `[contenteditable]` element, this method throws an error.
-    # However, if the element is inside the `<label>` element that has an associated
-    # [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), the control will be filled
-    # instead.
+    # This method waits for an element matching `selector`, waits for [actionability](../actionability.md) checks, focuses the element, fills it and triggers an `input` event after filling. Note that you can pass an empty string to clear the input field.
+    #
+    # If the target element is not an `<input>`, `<textarea>` or `[contenteditable]` element, this method throws an error. However, if the element is inside the `<label>` element that has an associated [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), the control will be filled instead.
     #
     # To send fine-grained keyboard events, use [`method: Frame.type`].
     def fill(
@@ -308,12 +311,14 @@ module Playwright
       wrap_impl(@impl.fill(unwrap_impl(selector), unwrap_impl(value), force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
-    # This method fetches an element with `selector` and focuses it. If there's no element matching `selector`, the method
-    # waits until a matching element appears in the DOM.
+    #
+    # This method fetches an element with `selector` and focuses it. If there's no element matching
+    # `selector`, the method waits until a matching element appears in the DOM.
     def focus(selector, strict: nil, timeout: nil)
       wrap_impl(@impl.focus(unwrap_impl(selector), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
+    #
     # Returns the `frame` or `iframe` element handle which corresponds to this frame.
     #
     # This is an inverse of [`method: ElementHandle.contentFrame`]. Note that returned handle actually belongs to the parent
@@ -321,6 +326,8 @@ module Playwright
     #
     # This method throws an error if the frame has been detached before `frameElement()` returns.
     #
+    # **Usage**
+    #
     # ```python sync
     # frame_element = frame.frame_element()
     # content_frame = frame_element.content_frame()
@@ -330,9 +337,13 @@ module Playwright
       wrap_impl(@impl.frame_element)
     end
 
-    # When working with iframes, you can create a frame locator that will enter the iframe and allow selecting elements in
-    # that iframe. Following snippet locates element with text "Submit" in the iframe with id `my-frame`, like `<iframe
-    # id="my-frame">`:
+    #
+    # When working with iframes, you can create a frame locator that will enter the iframe and allow selecting elements
+    # in that iframe.
+    #
+    # **Usage**
+    #
+    # Following snippet locates element with text "Submit" in the iframe with id `my-frame`, like `<iframe id="my-frame">`:
     #
     # ```python sync
     # locator = frame.frame_locator("#my-iframe").get_by_text("Submit")
@@ -342,11 +353,13 @@ module Playwright
       wrap_impl(@impl.frame_locator(unwrap_impl(selector)))
     end
 
+    #
     # Returns element attribute value.
     def get_attribute(selector, name, strict: nil, timeout: nil)
       wrap_impl(@impl.get_attribute(unwrap_impl(selector), unwrap_impl(name), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
+    #
     # Allows locating elements by their alt text. For example, this method will find the image by alt text "Castle":
     #
     # ```html
@@ -356,8 +369,8 @@ module Playwright
       wrap_impl(@impl.get_by_alt_text(unwrap_impl(text), exact: unwrap_impl(exact)))
     end
 
-    # Allows locating input elements by the text of the associated label. For example, this method will find the input by
-    # label text "Password" in the following DOM:
+    #
+    # Allows locating input elements by the text of the associated label. For example, this method will find the input by label text "Password" in the following DOM:
     #
     # ```html
     # <label for="password-input">Password:</label>
@@ -367,8 +380,8 @@ module Playwright
       wrap_impl(@impl.get_by_label(unwrap_impl(text), exact: unwrap_impl(exact)))
     end
 
-    # Allows locating input elements by the placeholder text. For example, this method will find the input by placeholder
-    # "Country":
+    #
+    # Allows locating input elements by the placeholder text. For example, this method will find the input by placeholder "Country":
     #
     # ```html
     # <input placeholder="Country">
@@ -377,15 +390,10 @@ module Playwright
       wrap_impl(@impl.get_by_placeholder(unwrap_impl(text), exact: unwrap_impl(exact)))
     end
 
-    # Allows locating elements by their [ARIA role](https://www.w3.org/TR/wai-aria-1.2/#roles),
-    # [ARIA attributes](https://www.w3.org/TR/wai-aria-1.2/#aria-attributes) and
-    # [accessible name](https://w3c.github.io/accname/#dfn-accessible-name). Note that role selector **does not replace**
-    # accessibility audits and conformance tests, but rather gives early feedback about the ARIA guidelines.
     #
-    # Note that many html elements have an implicitly
-    # [defined role](https://w3c.github.io/html-aam/#html-element-role-mappings) that is recognized by the role selector. You
-    # can find all the [supported roles here](https://www.w3.org/TR/wai-aria-1.2/#role_definitions). ARIA guidelines **do not
-    # recommend** duplicating implicit roles and attributes by setting `role` and/or `aria-*` attributes to default values.
+    # Allows locating elements by their [ARIA role](https://www.w3.org/TR/wai-aria-1.2/#roles), [ARIA attributes](https://www.w3.org/TR/wai-aria-1.2/#aria-attributes) and [accessible name](https://w3c.github.io/accname/#dfn-accessible-name). Note that role selector **does not replace** accessibility audits and conformance tests, but rather gives early feedback about the ARIA guidelines.
+    #
+    # Note that many html elements have an implicitly [defined role](https://w3c.github.io/html-aam/#html-element-role-mappings) that is recognized by the role selector. You can find all the [supported roles here](https://www.w3.org/TR/wai-aria-1.2/#role_definitions). ARIA guidelines **do not recommend** duplicating implicit roles and attributes by setting `role` and/or `aria-*` attributes to default values.
     def get_by_role(
           role,
           checked: nil,
@@ -400,12 +408,13 @@ module Playwright
       wrap_impl(@impl.get_by_role(unwrap_impl(role), checked: unwrap_impl(checked), disabled: unwrap_impl(disabled), exact: unwrap_impl(exact), expanded: unwrap_impl(expanded), includeHidden: unwrap_impl(includeHidden), level: unwrap_impl(level), name: unwrap_impl(name), pressed: unwrap_impl(pressed), selected: unwrap_impl(selected)))
     end
 
-    # Locate element by the test id. By default, the `data-testid` attribute is used as a test id. Use
-    # [`method: Selectors.setTestIdAttribute`] to configure a different test id attribute if necessary.
+    #
+    # Locate element by the test id. By default, the `data-testid` attribute is used as a test id. Use [`method: Selectors.setTestIdAttribute`] to configure a different test id attribute if necessary.
     def get_by_test_id(testId)
       wrap_impl(@impl.get_by_test_id(unwrap_impl(testId)))
     end
 
+    #
     # Allows locating elements that contain given text. Consider the following DOM structure:
     #
     # ```html
@@ -432,17 +441,16 @@ module Playwright
     # page.get_by_text(re.compile("^hello$", re.IGNORECASE))
     # ```
     #
-    # See also [`method: Locator.filter`] that allows to match by another criteria, like an accessible role, and then filter
-    # by the text content.
+    # See also [`method: Locator.filter`] that allows to match by another criteria, like an accessible role, and then filter by the text content.
+    #
+    # **NOTE**: Matching by text always normalizes whitespace, even with exact match. For example, it turns multiple spaces into one, turns line breaks into spaces and ignores leading and trailing whitespace.
     #
-    # > NOTE: Matching by text always normalizes whitespace, even with exact match. For example, it turns multiple spaces into
-    # one, turns line breaks into spaces and ignores leading and trailing whitespace.
-    # > NOTE: Input elements of the type `button` and `submit` are matched by their `value` instead of the text content. For
-    # example, locating by text `"Log in"` matches `<input type=button value="Log in">`.
+    # **NOTE**: Input elements of the type `button` and `submit` are matched by their `value` instead of the text content. For example, locating by text `"Log in"` matches `<input type=button value="Log in">`.
     def get_by_text(text, exact: nil)
       wrap_impl(@impl.get_by_text(unwrap_impl(text), exact: unwrap_impl(exact)))
     end
 
+    #
     # Allows locating elements by their title. For example, this method will find the button by its title "Place the order":
     #
     # ```html
@@ -452,6 +460,7 @@ module Playwright
       wrap_impl(@impl.get_by_title(unwrap_impl(text), exact: unwrap_impl(exact)))
     end
 
+    #
     # Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the
     # last redirect.
     #
@@ -462,28 +471,29 @@ module Playwright
     # - the remote server does not respond or is unreachable.
     # - the main resource failed to load.
     #
-    # The method will not throw an error when any valid HTTP status code is returned by the remote server, including 404 "Not
-    # Found" and 500 "Internal Server Error".  The status code for such responses can be retrieved by calling
+    # The method will not throw an error when any valid HTTP status code is returned by the remote server, including 404
+    # "Not Found" and 500 "Internal Server Error".  The status code for such responses can be retrieved by calling
     # [`method: Response.status`].
     #
-    # > NOTE: The method either throws an error or returns a main resource response. The only exceptions are navigation to
+    # **NOTE**: The method either throws an error or returns a main resource response. The only exceptions are navigation to
     # `about:blank` or navigation to the same URL with a different hash, which would succeed and return `null`.
-    # > NOTE: Headless mode doesn't support navigation to a PDF document. See the
+    #
+    # **NOTE**: Headless mode doesn't support navigation to a PDF document. See the
     # [upstream issue](https://bugs.chromium.org/p/chromium/issues/detail?id=761295).
     def goto(url, referer: nil, timeout: nil, waitUntil: nil)
       wrap_impl(@impl.goto(unwrap_impl(url), referer: unwrap_impl(referer), timeout: unwrap_impl(timeout), waitUntil: unwrap_impl(waitUntil)))
     end
 
+    #
     # This method hovers over an element matching `selector` by performing the following steps:
     # 1. Find an element matching `selector`. If there is none, wait until a matching element is attached to the DOM.
-    # 1. Wait for [actionability](../actionability.md) checks on the matched element, unless `force` option is set. If the
-    #    element is detached during the checks, the whole action is retried.
+    # 1. Wait for [actionability](../actionability.md) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried.
     # 1. Scroll the element into view if needed.
     # 1. Use [`property: Page.mouse`] to hover over the center of the element, or the specified `position`.
     # 1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set.
     #
-    # When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`. Passing
-    # zero timeout disables this.
+    # When all steps combined have not finished during the specified `timeout`, this method throws a
+    # `TimeoutError`. Passing zero timeout disables this.
     def hover(
           selector,
           force: nil,
@@ -496,64 +506,71 @@ module Playwright
       wrap_impl(@impl.hover(unwrap_impl(selector), force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
+    #
     # Returns `element.innerHTML`.
     def inner_html(selector, strict: nil, timeout: nil)
       wrap_impl(@impl.inner_html(unwrap_impl(selector), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
+    #
     # Returns `element.innerText`.
     def inner_text(selector, strict: nil, timeout: nil)
       wrap_impl(@impl.inner_text(unwrap_impl(selector), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
+    #
     # Returns `input.value` for the selected `<input>` or `<textarea>` or `<select>` element.
     #
-    # Throws for non-input elements. However, if the element is inside the `<label>` element that has an associated
-    # [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), returns the value of the control.
+    # Throws for non-input elements. However, if the element is inside the `<label>` element that has an associated [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), returns the value of the control.
     def input_value(selector, strict: nil, timeout: nil)
       wrap_impl(@impl.input_value(unwrap_impl(selector), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
+    #
     # Returns whether the element is checked. Throws if the element is not a checkbox or radio input.
     def checked?(selector, strict: nil, timeout: nil)
       wrap_impl(@impl.checked?(unwrap_impl(selector), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
+    #
     # Returns `true` if the frame has been detached, or `false` otherwise.
     def detached?
       wrap_impl(@impl.detached?)
     end
 
+    #
     # Returns whether the element is disabled, the opposite of [enabled](../actionability.md#enabled).
     def disabled?(selector, strict: nil, timeout: nil)
       wrap_impl(@impl.disabled?(unwrap_impl(selector), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
+    #
     # Returns whether the element is [editable](../actionability.md#editable).
     def editable?(selector, strict: nil, timeout: nil)
       wrap_impl(@impl.editable?(unwrap_impl(selector), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
+    #
     # Returns whether the element is [enabled](../actionability.md#enabled).
     def enabled?(selector, strict: nil, timeout: nil)
       wrap_impl(@impl.enabled?(unwrap_impl(selector), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
-    # Returns whether the element is hidden, the opposite of [visible](../actionability.md#visible).  `selector` that does not
-    # match any elements is considered hidden.
+    #
+    # Returns whether the element is hidden, the opposite of [visible](../actionability.md#visible).  `selector` that does not match any elements is considered hidden.
     def hidden?(selector, strict: nil, timeout: nil)
       wrap_impl(@impl.hidden?(unwrap_impl(selector), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
-    # Returns whether the element is [visible](../actionability.md#visible). `selector` that does not match any elements is
-    # considered not visible.
+    #
+    # Returns whether the element is [visible](../actionability.md#visible). `selector` that does not match any elements is considered not visible.
     def visible?(selector, strict: nil, timeout: nil)
       wrap_impl(@impl.visible?(unwrap_impl(selector), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
-    # The method returns an element locator that can be used to perform actions on this page / frame. Locator is resolved to
-    # the element immediately before performing an action, so a series of actions on the same locator can in fact be performed
-    # on different DOM elements. That would happen if the DOM structure between those actions has changed.
+    #
+    # The method returns an element locator that can be used to perform actions on this page / frame.
+    # Locator is resolved to the element immediately before performing an action, so a series of actions on the same locator can in fact be performed on different DOM elements. That would happen if the DOM structure between those actions has changed.
     #
     # [Learn more about locators](../locators.md).
     #
@@ -562,27 +579,32 @@ module Playwright
       wrap_impl(@impl.locator(unwrap_impl(selector), has: unwrap_impl(has), hasText: unwrap_impl(hasText)))
     end
 
+    #
     # Returns frame's name attribute as specified in the tag.
     #
     # If the name is empty, returns the id attribute instead.
     #
-    # > NOTE: This value is calculated once when the frame is created, and will not update if the attribute is changed later.
+    # **NOTE**: This value is calculated once when the frame is created, and will not update if the attribute is changed later.
     def name
       wrap_impl(@impl.name)
     end
 
+    #
     # Returns the page containing this frame.
     def page
       wrap_impl(@impl.page)
     end
 
+    #
     # Parent frame, if any. Detached frames and main frames return `null`.
     def parent_frame
       wrap_impl(@impl.parent_frame)
     end
 
-    # `key` can specify the intended [keyboardEvent.key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key)
-    # value or a single character to generate the text for. A superset of the `key` values can be found
+    #
+    # `key` can specify the intended
+    # [keyboardEvent.key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) value or a single character to
+    # generate the text for. A superset of the `key` values can be found
     # [here](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values). Examples of the keys are:
     #
     # `F1` - `F12`, `Digit0`- `Digit9`, `KeyA`- `KeyZ`, `Backquote`, `Minus`, `Equal`, `Backslash`, `Backspace`, `Tab`,
@@ -592,8 +614,8 @@ module Playwright
     #
     # Holding down `Shift` will type the text that corresponds to the `key` in the upper case.
     #
-    # If `key` is a single character, it is case-sensitive, so the values `a` and `A` will generate different respective
-    # texts.
+    # If `key` is a single character, it is case-sensitive, so the values `a` and `A` will generate different
+    # respective texts.
     #
     # Shortcuts such as `key: "Control+o"` or `key: "Control+Shift+T"` are supported as well. When specified with the
     # modifier, modifier is pressed and being held while the subsequent key is being pressed.
@@ -607,37 +629,39 @@ module Playwright
       wrap_impl(@impl.press(unwrap_impl(selector), unwrap_impl(key), delay: unwrap_impl(delay), noWaitAfter: unwrap_impl(noWaitAfter), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
+    #
     # Returns the ElementHandle pointing to the frame element.
     #
-    # > NOTE: The use of `ElementHandle` is discouraged, use `Locator` objects and web-first assertions instead.
+    # **NOTE**: The use of `ElementHandle` is discouraged, use `Locator` objects and web-first assertions instead.
     #
-    # The method finds an element matching the specified selector within the frame. See
-    # [Working with selectors](../selectors.md) for more details. If no elements match the selector, returns `null`.
+    # The method finds an element matching the specified selector within the frame. If no elements match the selector,
+    # returns `null`.
     def query_selector(selector, strict: nil)
       wrap_impl(@impl.query_selector(unwrap_impl(selector), strict: unwrap_impl(strict)))
     end
 
+    #
     # Returns the ElementHandles pointing to the frame elements.
     #
-    # > NOTE: The use of `ElementHandle` is discouraged, use `Locator` objects instead.
+    # **NOTE**: The use of `ElementHandle` is discouraged, use `Locator` objects instead.
     #
-    # The method finds all elements matching the specified selector within the frame. See
-    # [Working with selectors](../selectors.md) for more details. If no elements match the selector, returns empty array.
+    # The method finds all elements matching the specified selector within the frame. If no elements match the selector,
+    # returns empty array.
     def query_selector_all(selector)
       wrap_impl(@impl.query_selector_all(unwrap_impl(selector)))
     end
 
-    # This method waits for an element matching `selector`, waits for [actionability](../actionability.md) checks, waits until
-    # all specified options are present in the `<select>` element and selects these options.
     #
-    # If the target element is not a `<select>` element, this method throws an error. However, if the element is inside the
-    # `<label>` element that has an associated
-    # [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), the control will be used instead.
+    # This method waits for an element matching `selector`, waits for [actionability](../actionability.md) checks, waits until all specified options are present in the `<select>` element and selects these options.
+    #
+    # If the target element is not a `<select>` element, this method throws an error. However, if the element is inside the `<label>` element that has an associated [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), the control will be used instead.
     #
     # Returns the array of option values that have been successfully selected.
     #
     # Triggers a `change` and `input` event once all the provided options have been selected.
     #
+    # **Usage**
+    #
     # ```python sync
     # # single selection matching the value
     # frame.select_option("select#colors", "blue")
@@ -659,19 +683,19 @@ module Playwright
       wrap_impl(@impl.select_option(unwrap_impl(selector), element: unwrap_impl(element), index: unwrap_impl(index), value: unwrap_impl(value), label: unwrap_impl(label), force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
+    #
     # This method checks or unchecks an element matching `selector` by performing the following steps:
     # 1. Find an element matching `selector`. If there is none, wait until a matching element is attached to the DOM.
     # 1. Ensure that matched element is a checkbox or a radio input. If not, this method throws.
     # 1. If the element already has the right checked state, this method returns immediately.
-    # 1. Wait for [actionability](../actionability.md) checks on the matched element, unless `force` option is set. If the
-    #    element is detached during the checks, the whole action is retried.
+    # 1. Wait for [actionability](../actionability.md) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried.
     # 1. Scroll the element into view if needed.
     # 1. Use [`property: Page.mouse`] to click in the center of the element.
     # 1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set.
     # 1. Ensure that the element is now checked or unchecked. If not, this method throws.
     #
-    # When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`. Passing
-    # zero timeout disables this.
+    # When all steps combined have not finished during the specified `timeout`, this method throws a
+    # `TimeoutError`. Passing zero timeout disables this.
     def set_checked(
           selector,
           checked,
@@ -689,13 +713,12 @@ module Playwright
     end
     alias_method :content=, :set_content
 
+    #
     # Sets the value of the file input to these file paths or files. If some of the `filePaths` are relative paths, then they
     # are resolved relative to the current working directory. For empty array, clears the selected files.
     #
     # This method expects `selector` to point to an
-    # [input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input). However, if the element is inside the
-    # `<label>` element that has an associated
-    # [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), targets the control instead.
+    # [input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input). However, if the element is inside the `<label>` element that has an associated [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), targets the control instead.
     def set_input_files(
           selector,
           files,
@@ -705,18 +728,18 @@ module Playwright
       wrap_impl(@impl.set_input_files(unwrap_impl(selector), unwrap_impl(files), noWaitAfter: unwrap_impl(noWaitAfter), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
+    #
     # This method taps an element matching `selector` by performing the following steps:
     # 1. Find an element matching `selector`. If there is none, wait until a matching element is attached to the DOM.
-    # 1. Wait for [actionability](../actionability.md) checks on the matched element, unless `force` option is set. If the
-    #    element is detached during the checks, the whole action is retried.
+    # 1. Wait for [actionability](../actionability.md) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried.
     # 1. Scroll the element into view if needed.
     # 1. Use [`property: Page.touchscreen`] to tap the center of the element, or the specified `position`.
     # 1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set.
     #
-    # When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`. Passing
-    # zero timeout disables this.
+    # When all steps combined have not finished during the specified `timeout`, this method throws a
+    # `TimeoutError`. Passing zero timeout disables this.
     #
-    # > NOTE: `frame.tap()` requires that the `hasTouch` option of the browser context be set to true.
+    # **NOTE**: `frame.tap()` requires that the `hasTouch` option of the browser context be set to true.
     def tap_point(
           selector,
           force: nil,
@@ -729,21 +752,26 @@ module Playwright
       wrap_impl(@impl.tap_point(unwrap_impl(selector), force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
+    #
     # Returns `element.textContent`.
     def text_content(selector, strict: nil, timeout: nil)
       wrap_impl(@impl.text_content(unwrap_impl(selector), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
+    #
     # Returns the page title.
     def title
       wrap_impl(@impl.title)
     end
 
+    #
     # Sends a `keydown`, `keypress`/`input`, and `keyup` event for each character in the text. `frame.type` can be used to
     # send fine-grained keyboard events. To fill values in form fields, use [`method: Frame.fill`].
     #
     # To press a special key, like `Control` or `ArrowDown`, use [`method: Keyboard.press`].
     #
+    # **Usage**
+    #
     # ```python sync
     # frame.type("#mytextarea", "hello") # types instantly
     # frame.type("#mytextarea", "world", delay=100) # types slower, like a user
@@ -758,19 +786,18 @@ module Playwright
       wrap_impl(@impl.type(unwrap_impl(selector), unwrap_impl(text), delay: unwrap_impl(delay), noWaitAfter: unwrap_impl(noWaitAfter), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
+    #
     # This method checks an element matching `selector` by performing the following steps:
     # 1. Find an element matching `selector`. If there is none, wait until a matching element is attached to the DOM.
-    # 1. Ensure that matched element is a checkbox or a radio input. If not, this method throws. If the element is already
-    #    unchecked, this method returns immediately.
-    # 1. Wait for [actionability](../actionability.md) checks on the matched element, unless `force` option is set. If the
-    #    element is detached during the checks, the whole action is retried.
+    # 1. Ensure that matched element is a checkbox or a radio input. If not, this method throws. If the element is already unchecked, this method returns immediately.
+    # 1. Wait for [actionability](../actionability.md) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried.
     # 1. Scroll the element into view if needed.
     # 1. Use [`property: Page.mouse`] to click in the center of the element.
     # 1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set.
     # 1. Ensure that the element is now unchecked. If not, this method throws.
     #
-    # When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`. Passing
-    # zero timeout disables this.
+    # When all steps combined have not finished during the specified `timeout`, this method throws a
+    # `TimeoutError`. Passing zero timeout disables this.
     def uncheck(
           selector,
           force: nil,
@@ -782,13 +809,17 @@ module Playwright
       wrap_impl(@impl.uncheck(unwrap_impl(selector), force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
+    #
     # Returns frame's url.
     def url
       wrap_impl(@impl.url)
     end
 
+    #
     # Returns when the `expression` returns a truthy value, returns that value.
     #
+    # **Usage**
+    #
     # The [`method: Frame.waitForFunction`] can be used to observe viewport size change:
     #
     # ```python sync
@@ -816,11 +847,14 @@ module Playwright
       wrap_impl(@impl.wait_for_function(unwrap_impl(expression), arg: unwrap_impl(arg), polling: unwrap_impl(polling), timeout: unwrap_impl(timeout)))
     end
 
+    #
     # Waits for the required load state to be reached.
     #
     # This returns when the frame reaches a required load state, `load` by default. The navigation must have been committed
     # when this method is called. If current document has already reached the required state, resolves immediately.
     #
+    # **Usage**
+    #
     # ```python sync
     # frame.click("button") # click triggers navigation.
     # frame.wait_for_load_state() # the promise resolves after "load" event.
@@ -829,10 +863,13 @@ module Playwright
       wrap_impl(@impl.wait_for_load_state(state: unwrap_impl(state), timeout: unwrap_impl(timeout)))
     end
 
+    #
     # Waits for the frame navigation and returns the main resource response. In case of multiple redirects, the navigation
     # will resolve with the response of the last redirect. In case of navigation to a different anchor or navigation due to
     # History API usage, the navigation will resolve with `null`.
     #
+    # **Usage**
+    #
     # This method waits for the frame to navigate to a new URL. It is useful for when you run code which will indirectly cause
     # the frame to navigate. Consider this example:
     #
@@ -842,21 +879,25 @@ module Playwright
     # # Resolves after navigation has finished
     # ```
     #
-    # > NOTE: Usage of the [History API](https://developer.mozilla.org/en-US/docs/Web/API/History_API) to change the URL is
-    # considered a navigation.
+    # **NOTE**: Usage of the [History API](https://developer.mozilla.org/en-US/docs/Web/API/History_API) to change the URL is considered
+    # a navigation.
     def expect_navigation(timeout: nil, url: nil, waitUntil: nil, &block)
       wrap_impl(@impl.expect_navigation(timeout: unwrap_impl(timeout), url: unwrap_impl(url), waitUntil: unwrap_impl(waitUntil), &wrap_block_call(block)))
     end
 
+    #
     # Returns when element specified by selector satisfies `state` option. Returns `null` if waiting for `hidden` or
     # `detached`.
     #
-    # > NOTE: Playwright automatically waits for element to be ready before performing an action. Using `Locator` objects and
-    # web-first assertions make the code wait-for-selector-free.
+    # **NOTE**: Playwright automatically waits for element to be ready before performing an action. Using
+    # `Locator` objects and web-first assertions make the code wait-for-selector-free.
     #
-    # Wait for the `selector` to satisfy `state` option (either appear/disappear from dom, or become visible/hidden). If at
-    # the moment of calling the method `selector` already satisfies the condition, the method will return immediately. If the
-    # selector doesn't satisfy the condition for the `timeout` milliseconds, the function will throw.
+    # Wait for the `selector` to satisfy `state` option (either appear/disappear from dom, or become
+    # visible/hidden). If at the moment of calling the method `selector` already satisfies the condition, the method
+    # will return immediately. If the selector doesn't satisfy the condition for the `timeout` milliseconds, the
+    # function will throw.
+    #
+    # **Usage**
     #
     # This method works across navigations:
     #
@@ -880,6 +921,7 @@ module Playwright
       wrap_impl(@impl.wait_for_selector(unwrap_impl(selector), state: unwrap_impl(state), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
+    #
     # Waits for the given `timeout` in milliseconds.
     #
     # Note that `frame.waitForTimeout()` should only be used for debugging. Tests using the timer in production are going to
@@ -888,8 +930,11 @@ module Playwright
       wrap_impl(@impl.wait_for_timeout(unwrap_impl(timeout)))
     end
 
+    #
     # Waits for the frame to navigate to the given URL.
     #
+    # **Usage**
+    #
     # ```python sync
     # frame.click("a.delayed-navigation") # clicking the link will indirectly cause a navigation
     # frame.wait_for_url("**/target.html")