From fe2c529fdac68975811e524cc7f4f3231887e7a4 Mon Sep 17 00:00:00 2001 From: Pavel Feldman Date: Wed, 3 Feb 2021 18:25:06 -0800 Subject: [PATCH] docs: complete sentences with full stop (#5298) --- docs/src/api/class-elementhandle.md | 4 ++-- docs/src/api/class-frame.md | 10 ++++----- docs/src/api/class-jshandle.md | 4 ++-- docs/src/api/class-page.md | 10 ++++----- docs/src/api/class-worker.md | 4 ++-- types/types.d.ts | 32 ++++++++++++++--------------- 6 files changed, 32 insertions(+), 32 deletions(-) diff --git a/docs/src/api/class-elementhandle.md b/docs/src/api/class-elementhandle.md index fb898204ef5a7..46be32448b360 100644 --- a/docs/src/api/class-elementhandle.md +++ b/docs/src/api/class-elementhandle.md @@ -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 diff --git a/docs/src/api/class-frame.md b/docs/src/api/class-frame.md index 8f54f9cda9096..641ec5b469669 100644 --- a/docs/src/api/class-frame.md +++ b/docs/src/api/class-frame.md @@ -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"> diff --git a/docs/src/api/class-jshandle.md b/docs/src/api/class-jshandle.md index 9d8cd01a3092a..62fb54224fe40 100644 --- a/docs/src/api/class-jshandle.md +++ b/docs/src/api/class-jshandle.md @@ -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]>> diff --git a/docs/src/api/class-page.md b/docs/src/api/class-page.md index ce46e32fd05a8..5193662706f97 100644 --- a/docs/src/api/class-page.md +++ b/docs/src/api/class-page.md @@ -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"> diff --git a/docs/src/api/class-worker.md b/docs/src/api/class-worker.md index 89ee1961f4f06..e8dd0b0ffe9a5 100644 --- a/docs/src/api/class-worker.md +++ b/docs/src/api/class-worker.md @@ -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]> diff --git a/types/types.d.ts b/types/types.d.ts index 04e0be5a137d0..66c7b48ec290d 100644 --- a/types/types.d.ts +++ b/types/types.d.ts @@ -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(pageFunction: PageFunction, arg: Arg): Promise; evaluate(pageFunction: PageFunction, arg?: any): Promise; @@ -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(pageFunction: PageFunction, arg: Arg): Promise>; evaluateHandle(pageFunction: PageFunction, arg?: any): Promise>; @@ -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(selector: K, pageFunction: PageFunctionOn, arg: Arg): Promise; $eval(selector: string, pageFunction: PageFunctionOn, arg: Arg): Promise; @@ -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(selector: K, pageFunction: PageFunctionOn, arg: Arg): Promise; $$eval(selector: string, pageFunction: PageFunctionOn, arg: Arg): Promise; @@ -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(pageFunction: PageFunction, arg: Arg, options?: PageWaitForFunctionOptions): Promise>; @@ -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(pageFunction: PageFunction, arg: Arg): Promise; evaluate(pageFunction: PageFunction, arg?: any): Promise; @@ -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(pageFunction: PageFunction, arg: Arg): Promise>; evaluateHandle(pageFunction: PageFunction, arg?: any): Promise>; @@ -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(selector: K, pageFunction: PageFunctionOn, arg: Arg): Promise; $eval(selector: string, pageFunction: PageFunctionOn, arg: Arg): Promise; @@ -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(selector: K, pageFunction: PageFunctionOn, arg: Arg): Promise; $$eval(selector: string, pageFunction: PageFunctionOn, arg: Arg): Promise; @@ -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(pageFunction: PageFunction, arg: Arg, options?: PageWaitForFunctionOptions): Promise>; @@ -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(pageFunction: PageFunction, arg: Arg): Promise; evaluate(pageFunction: PageFunction, arg?: any): Promise; @@ -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(pageFunction: PageFunction, arg: Arg): Promise>; evaluateHandle(pageFunction: PageFunction, arg?: any): Promise>; @@ -5248,7 +5248,7 @@ export interface JSHandle { * ``` * * @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(pageFunction: PageFunctionOn, arg: Arg): Promise; evaluate(pageFunction: PageFunctionOn, arg?: any): Promise; @@ -5268,7 +5268,7 @@ export interface JSHandle { * [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(pageFunction: PageFunctionOn, arg: Arg): Promise>; evaluateHandle(pageFunction: PageFunctionOn, arg?: any): Promise>; @@ -5375,7 +5375,7 @@ export interface ElementHandle extends JSHandle { * * @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(selector: K, pageFunction: PageFunctionOn, arg: Arg): Promise; $eval(selector: string, pageFunction: PageFunctionOn, arg: Arg): Promise; @@ -5408,7 +5408,7 @@ export interface ElementHandle extends JSHandle { * * @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(selector: K, pageFunction: PageFunctionOn, arg: Arg): Promise; $$eval(selector: string, pageFunction: PageFunctionOn, arg: Arg): Promise;