root
/
playwright
mirror of https://github.com/microsoft/playwright.git
1
0
Fork 0
Code Issues Actions 1 Packages Projects Releases Wiki Activity

docs: complete sentences with full stop (#5298)

This commit is contained in:
Pavel Feldman 2021-02-03 18:25:06 -08:00 committed by GitHub
parent 9841f6dbcb
commit fe2c529fda
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 32 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/src/api/class-elementhandle.md
View File

@ -283,7 +283,7 @@ assert tweet_handle.eval_on_selector(".retweets", "node => node.innerText") = "1
### param: ElementHandle.evalOnSelector.arg
- `arg` <[EvaluationArgument]>
Optional argument to pass to [`param: expression`]
Optional argument to pass to [`param: expression`].
## async method: ElementHandle.evalOnSelectorAll
* langs:
@ -331,7 +331,7 @@ assert feed_handle.eval_on_selector_all(".tweet", "nodes => nodes.map(n => n.inn
### param: ElementHandle.evalOnSelectorAll.arg
- `arg` <[EvaluationArgument]>
Optional argument to pass to [`param: expression`]
Optional argument to pass to [`param: expression`].
## async method: ElementHandle.fill

10
docs/src/api/class-frame.md
View File

@ -336,7 +336,7 @@ html = frame.eval_on_selector(".main-container", "(e, suffix) => e.outerHTML + s
### param: Frame.evalOnSelector.arg
- `arg` <[EvaluationArgument]>
Optional argument to pass to [`param: expression`]
Optional argument to pass to [`param: expression`].
## async method: Frame.evalOnSelectorAll
* langs:
@ -374,7 +374,7 @@ divs_counts = frame.eval_on_selector_all("div", "(divs, min) => divs.length >= m
### param: Frame.evalOnSelectorAll.arg
- `arg` <[EvaluationArgument]>
Optional argument to pass to [`param: expression`]
Optional argument to pass to [`param: expression`].
## async method: Frame.evaluate
- returns: <[Serializable]>
@ -450,7 +450,7 @@ body_handle.dispose()
### param: Frame.evaluate.arg
- `arg` <[EvaluationArgument]>
Optional argument to pass to [`param: expression`]
Optional argument to pass to [`param: expression`].
## async method: Frame.evaluateHandle
- returns: <[JSHandle]>
@ -520,7 +520,7 @@ result_handle.dispose()
### param: Frame.evaluateHandle.arg
- `arg` <[EvaluationArgument]>
Optional argument to pass to [`param: expression`]
Optional argument to pass to [`param: expression`].
## async method: Frame.fill
@ -1084,7 +1084,7 @@ frame.wait_for_function("selector => !!document.querySelector(selector)", select
### param: Frame.waitForFunction.arg
- `arg` <[EvaluationArgument]>
Optional argument to pass to [`param: expression`]
Optional argument to pass to [`param: expression`].
### option: Frame.waitForFunction.polling
- `polling` <[float]|"raf">

4
docs/src/api/class-jshandle.md
View File

@ -66,7 +66,7 @@ assert tweet_handle.evaluate("node => node.innerText") == "10 retweets"
### param: JSHandle.evaluate.arg
- `arg` <[EvaluationArgument]>
Optional argument to pass to [`param: expression`]
Optional argument to pass to [`param: expression`].
## async method: JSHandle.evaluateHandle
- returns: <[JSHandle]>
@ -87,7 +87,7 @@ See [`method: Page.evaluateHandle`] for more details.
### param: JSHandle.evaluateHandle.arg
- `arg` <[EvaluationArgument]>
Optional argument to pass to [`param: expression`]
Optional argument to pass to [`param: expression`].
## async method: JSHandle.getProperties
- returns: <[Map]<[string], [JSHandle]>>

10
docs/src/api/class-page.md
View File

@ -765,7 +765,7 @@ Shortcut for main frame's [`method: Frame.evalOnSelector`].
### param: Page.evalOnSelector.arg
- `arg` <[EvaluationArgument]>
Optional argument to pass to [`param: expression`]
Optional argument to pass to [`param: expression`].
## async method: Page.evalOnSelectorAll
* langs:
@ -800,7 +800,7 @@ div_counts = page.eval_on_selector_all("div", "(divs, min) => divs.length >= min
### param: Page.evalOnSelectorAll.arg
- `arg` <[EvaluationArgument]>
Optional argument to pass to [`param: expression`]
Optional argument to pass to [`param: expression`].
## async method: Page.evaluate
- returns: <[Serializable]>
@ -880,7 +880,7 @@ Shortcut for main frame's [`method: Frame.evaluate`].
### param: Page.evaluate.arg
- `arg` <[EvaluationArgument]>
Optional argument to pass to [`param: expression`]
Optional argument to pass to [`param: expression`].
## async method: Page.evaluateHandle
- returns: <[JSHandle]>
@ -949,7 +949,7 @@ result_handle.dispose()
### param: Page.evaluateHandle.arg
- `arg` <[EvaluationArgument]>
Optional argument to pass to [`param: expression`]
Optional argument to pass to [`param: expression`].
## async method: Page.exposeBinding
@ -2288,7 +2288,7 @@ Shortcut for main frame's [`method: Frame.waitForFunction`].
### param: Page.waitForFunction.arg
- `arg` <[EvaluationArgument]>
Optional argument to pass to [`param: expression`]
Optional argument to pass to [`param: expression`].
### option: Page.waitForFunction.polling
- `polling` <[float]|"raf">

4
docs/src/api/class-worker.md
View File

@ -48,7 +48,7 @@ additional values that are not serializable by `JSON`: `-0`, `NaN`, `Infinity`,
### param: Worker.evaluate.arg
- `arg` <[EvaluationArgument]>
Optional argument to pass to [`param: expression`]
Optional argument to pass to [`param: expression`].
## async method: Worker.evaluateHandle
- returns: <[JSHandle]>
@ -67,7 +67,7 @@ the promise to resolve and return its value.
### param: Worker.evaluateHandle.arg
- `arg` <[EvaluationArgument]>
Optional argument to pass to [`param: expression`]
Optional argument to pass to [`param: expression`].
## method: Worker.url
- returns: <[string]>

32
types/types.d.ts vendored
View File

@ -117,7 +117,7 @@ export interface Page {
* Shortcut for main frame's
* [frame.evaluate(pageFunction[, arg])](https://playwright.dev/docs/api/class-frame#frameevaluatepagefunction-arg).
* @param pageFunction Function to be evaluated in the page context.
* @param arg Optional argument to pass to `pageFunction`
* @param arg Optional argument to pass to `pageFunction`.
*/
evaluate<R, Arg>(pageFunction: PageFunction<Arg, R>, arg: Arg): Promise<R>;
evaluate<R>(pageFunction: PageFunction<void, R>, arg?: any): Promise<R>;
@ -160,7 +160,7 @@ export interface Page {
* ```
*
* @param pageFunction Function to be evaluated in the page context.
* @param arg Optional argument to pass to `pageFunction`
* @param arg Optional argument to pass to `pageFunction`.
*/
evaluateHandle<R, Arg>(pageFunction: PageFunction<Arg, R>, arg: Arg): Promise<SmartHandle<R>>;
evaluateHandle<R>(pageFunction: PageFunction<void, R>, arg?: any): Promise<SmartHandle<R>>;
@ -205,7 +205,7 @@ export interface Page {
* [frame.$eval(selector, pageFunction[, arg])](https://playwright.dev/docs/api/class-frame#frameevalselector-pagefunction-arg).
* @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/selectors) for more details.
* @param pageFunction Function to be evaluated in the page context.
* @param arg Optional argument to pass to `pageFunction`
* @param arg Optional argument to pass to `pageFunction`.
*/
$eval<K extends keyof HTMLElementTagNameMap, R, Arg>(selector: K, pageFunction: PageFunctionOn<HTMLElementTagNameMap[K], Arg, R>, arg: Arg): Promise<R>;
$eval<R, Arg, E extends SVGElement | HTMLElement = SVGElement | HTMLElement>(selector: string, pageFunction: PageFunctionOn<E, Arg, R>, arg: Arg): Promise<R>;
@ -228,7 +228,7 @@ export interface Page {
*
* @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/selectors) for more details.
* @param pageFunction Function to be evaluated in the page context.
* @param arg Optional argument to pass to `pageFunction`
* @param arg Optional argument to pass to `pageFunction`.
*/
$$eval<K extends keyof HTMLElementTagNameMap, R, Arg>(selector: K, pageFunction: PageFunctionOn<HTMLElementTagNameMap[K][], Arg, R>, arg: Arg): Promise<R>;
$$eval<R, Arg, E extends SVGElement | HTMLElement = SVGElement | HTMLElement>(selector: string, pageFunction: PageFunctionOn<E[], Arg, R>, arg: Arg): Promise<R>;
@ -267,7 +267,7 @@ export interface Page {
* Shortcut for main frame's
* [frame.waitForFunction(pageFunction[, arg, options])](https://playwright.dev/docs/api/class-frame#framewaitforfunctionpagefunction-arg-options).
* @param pageFunction Function to be evaluated in the page context.
* @param arg Optional argument to pass to `pageFunction`
* @param arg Optional argument to pass to `pageFunction`.
* @param options
*/
waitForFunction<R, Arg>(pageFunction: PageFunction<Arg, R>, arg: Arg, options?: PageWaitForFunctionOptions): Promise<SmartHandle<R>>;
@ -3258,7 +3258,7 @@ export interface Frame {
* ```
*
* @param pageFunction Function to be evaluated in the page context.
* @param arg Optional argument to pass to `pageFunction`
* @param arg Optional argument to pass to `pageFunction`.
*/
evaluate<R, Arg>(pageFunction: PageFunction<Arg, R>, arg: Arg): Promise<R>;
evaluate<R>(pageFunction: PageFunction<void, R>, arg?: any): Promise<R>;
@ -3299,7 +3299,7 @@ export interface Frame {
* ```
*
* @param pageFunction Function to be evaluated in the page context.
* @param arg Optional argument to pass to `pageFunction`
* @param arg Optional argument to pass to `pageFunction`.
*/
evaluateHandle<R, Arg>(pageFunction: PageFunction<Arg, R>, arg: Arg): Promise<SmartHandle<R>>;
evaluateHandle<R>(pageFunction: PageFunction<void, R>, arg?: any): Promise<SmartHandle<R>>;
@ -3345,7 +3345,7 @@ export interface Frame {
*
* @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/selectors) for more details.
* @param pageFunction Function to be evaluated in the page context.
* @param arg Optional argument to pass to `pageFunction`
* @param arg Optional argument to pass to `pageFunction`.
*/
$eval<K extends keyof HTMLElementTagNameMap, R, Arg>(selector: K, pageFunction: PageFunctionOn<HTMLElementTagNameMap[K], Arg, R>, arg: Arg): Promise<R>;
$eval<R, Arg, E extends SVGElement | HTMLElement = SVGElement | HTMLElement>(selector: string, pageFunction: PageFunctionOn<E, Arg, R>, arg: Arg): Promise<R>;
@ -3370,7 +3370,7 @@ export interface Frame {
*
* @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/selectors) for more details.
* @param pageFunction Function to be evaluated in the page context.
* @param arg Optional argument to pass to `pageFunction`
* @param arg Optional argument to pass to `pageFunction`.
*/
$$eval<K extends keyof HTMLElementTagNameMap, R, Arg>(selector: K, pageFunction: PageFunctionOn<HTMLElementTagNameMap[K][], Arg, R>, arg: Arg): Promise<R>;
$$eval<R, Arg, E extends SVGElement | HTMLElement = SVGElement | HTMLElement>(selector: string, pageFunction: PageFunctionOn<E[], Arg, R>, arg: Arg): Promise<R>;
@ -3405,7 +3405,7 @@ export interface Frame {
* ```
*
* @param pageFunction Function to be evaluated in the page context.
* @param arg Optional argument to pass to `pageFunction`
* @param arg Optional argument to pass to `pageFunction`.
* @param options
*/
waitForFunction<R, Arg>(pageFunction: PageFunction<Arg, R>, arg: Arg, options?: PageWaitForFunctionOptions): Promise<SmartHandle<R>>;
@ -5159,7 +5159,7 @@ export interface Worker {
* returns `undefined`. Playwright also supports transferring some additional values that are not serializable by `JSON`:
* `-0`, `NaN`, `Infinity`, `-Infinity`.
* @param pageFunction Function to be evaluated in the worker context.
* @param arg Optional argument to pass to `pageFunction`
* @param arg Optional argument to pass to `pageFunction`.
*/
evaluate<R, Arg>(pageFunction: PageFunction<Arg, R>, arg: Arg): Promise<R>;
evaluate<R>(pageFunction: PageFunction<void, R>, arg?: any): Promise<R>;
@ -5180,7 +5180,7 @@ export interface Worker {
* [worker.evaluateHandle(pageFunction[, arg])](https://playwright.dev/docs/api/class-worker#workerevaluatehandlepagefunction-arg)
* would wait for the promise to resolve and return its value.
* @param pageFunction Function to be evaluated in the worker context.
* @param arg Optional argument to pass to `pageFunction`
* @param arg Optional argument to pass to `pageFunction`.
*/
evaluateHandle<R, Arg>(pageFunction: PageFunction<Arg, R>, arg: Arg): Promise<SmartHandle<R>>;
evaluateHandle<R>(pageFunction: PageFunction<void, R>, arg?: any): Promise<SmartHandle<R>>;
@ -5248,7 +5248,7 @@ export interface JSHandle<T = any> {
* ```
*
* @param pageFunction Function to be evaluated in the page context.
* @param arg Optional argument to pass to `pageFunction`
* @param arg Optional argument to pass to `pageFunction`.
*/
evaluate<R, Arg, O extends T = T>(pageFunction: PageFunctionOn<O, Arg, R>, arg: Arg): Promise<R>;
evaluate<R, O extends T = T>(pageFunction: PageFunctionOn<O, void, R>, arg?: any): Promise<R>;
@ -5268,7 +5268,7 @@ export interface JSHandle<T = any> {
* [page.evaluateHandle(pageFunction[, arg])](https://playwright.dev/docs/api/class-page#pageevaluatehandlepagefunction-arg)
* for more details.
* @param pageFunction Function to be evaluated in the page context.
* @param arg Optional argument to pass to `pageFunction`
* @param arg Optional argument to pass to `pageFunction`.
*/
evaluateHandle<R, Arg, O extends T = T>(pageFunction: PageFunctionOn<O, Arg, R>, arg: Arg): Promise<SmartHandle<R>>;
evaluateHandle<R, O extends T = T>(pageFunction: PageFunctionOn<O, void, R>, arg?: any): Promise<SmartHandle<R>>;
@ -5375,7 +5375,7 @@ export interface ElementHandle<T=Node> extends JSHandle<T> {
*
* @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/selectors) for more details.
* @param pageFunction Function to be evaluated in the page context.
* @param arg Optional argument to pass to `pageFunction`
* @param arg Optional argument to pass to `pageFunction`.
*/
$eval<K extends keyof HTMLElementTagNameMap, R, Arg>(selector: K, pageFunction: PageFunctionOn<HTMLElementTagNameMap[K], Arg, R>, arg: Arg): Promise<R>;
$eval<R, Arg, E extends SVGElement | HTMLElement = SVGElement | HTMLElement>(selector: string, pageFunction: PageFunctionOn<E, Arg, R>, arg: Arg): Promise<R>;
@ -5408,7 +5408,7 @@ export interface ElementHandle<T=Node> extends JSHandle<T> {
*
* @param selector A selector to query for. See [working with selectors](https://playwright.dev/docs/selectors) for more details.
* @param pageFunction Function to be evaluated in the page context.
* @param arg Optional argument to pass to `pageFunction`
* @param arg Optional argument to pass to `pageFunction`.
*/
$$eval<K extends keyof HTMLElementTagNameMap, R, Arg>(selector: K, pageFunction: PageFunctionOn<HTMLElementTagNameMap[K][], Arg, R>, arg: Arg): Promise<R>;
$$eval<R, Arg, E extends SVGElement | HTMLElement = SVGElement | HTMLElement>(selector: string, pageFunction: PageFunctionOn<E[], Arg, R>, arg: Arg): Promise<R>;