Skip to content

Commit

Permalink
docs: always use number for polling option in java (#5519)
Browse files Browse the repository at this point in the history
  • Loading branch information
yury-s committed Feb 19, 2021
1 parent cbcc609 commit 6841da1
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 10 deletions.
7 changes: 2 additions & 5 deletions docs/src/api/class-frame.md
Expand Up @@ -1086,12 +1086,9 @@ frame.wait_for_function("selector => !!document.querySelector(selector)", select

Optional argument to pass to [`param: expression`].

### option: Frame.waitForFunction.polling
- `polling` <[float]|"raf">
### option: Frame.waitForFunction.polling = %%-js-python-wait-for-function-polling-%%

If [`option: polling`] is `'raf'`, then [`param: expression`] is constantly executed in `requestAnimationFrame`
callback. If [`option: polling`] is a number, then it is treated as an interval in milliseconds at which the function
would be executed. Defaults to `raf`.
### option: Frame.waitForFunction.polling = %%-csharp-java-wait-for-function-polling-%%

### option: Frame.waitForFunction.timeout = %%-wait-for-timeout-%%

Expand Down
7 changes: 2 additions & 5 deletions docs/src/api/class-page.md
Expand Up @@ -2411,12 +2411,9 @@ Shortcut for main frame's [`method: Frame.waitForFunction`].

Optional argument to pass to [`param: expression`].

### option: Page.waitForFunction.polling
- `polling` <[float]|"raf">
### option: Page.waitForFunction.polling = %%-js-python-wait-for-function-polling-%%

If [`option: polling`] is `'raf'`, then [`param: expression`] is constantly executed in `requestAnimationFrame`
callback. If [`option: polling`] is a number, then it is treated as an interval in milliseconds at which the function
would be executed. Defaults to `raf`.
### option: Page.waitForFunction.polling = %%-csharp-java-wait-for-function-polling-%%

### option: Page.waitForFunction.timeout = %%-wait-for-timeout-%%

Expand Down
14 changes: 14 additions & 0 deletions docs/src/api/params.md
Expand Up @@ -98,6 +98,20 @@ Defaults to `'visible'`. Can be either:
* `'hidden'` - wait for element to be either detached from DOM, or have an empty bounding box or `visibility:hidden`.
This is opposite to the `'visible'` option.

## js-python-wait-for-function-polling
* langs: js, python
- `polling` <[float]|"raf">

If [`option: polling`] is `'raf'`, then [`param: expression`] is constantly executed in `requestAnimationFrame`
callback. If [`option: polling`] is a number, then it is treated as an interval in milliseconds at which the function
would be executed. Defaults to `raf`.

## csharp-java-wait-for-function-polling
* langs: csharp, java
- `pollingInterval` <[float]>

If specified, then it is treated as an interval in milliseconds at which the function would be executed. By default if the option is not specified [`param: expression`] is executed in `requestAnimationFrame` callback.

## browser-option-ignoredefaultargs
* langs: js, python
- `ignoreDefaultArgs` <[boolean]|[Array]<[string]>>
Expand Down

0 comments on commit 6841da1

Please sign in to comment.