docs: remove some redundant instances of @returns (#9943)

puppeteer · Mar 30, 2023 · 1396274 · 1396274
1 parent e0eef01
commit 1396274
Show file tree

Hide file tree

Showing 106 changed files with 364 additions and 361 deletions.
diff --git a/docs/api/puppeteer.browserfetcher.host.md b/docs/api/puppeteer.browserfetcher.host.md
@@ -4,6 +4,8 @@ sidebar_label: BrowserFetcher.host
 
 # BrowserFetcher.host() method
 
+The download host being used.
+
 #### Signature:
 
 ```typescript
@@ -15,5 +17,3 @@ class BrowserFetcher {
 **Returns:**
 
 string
-
-The download host being used.
diff --git a/docs/api/puppeteer.browserfetcher.md b/docs/api/puppeteer.browserfetcher.md
@@ -36,13 +36,13 @@ const browser = await puppeteer.launch({
 
 ## Methods
 
-| Method                                                                         | Modifiers | Description                                                     |
-| ------------------------------------------------------------------------------ | --------- | --------------------------------------------------------------- |
-| [canDownload(revision)](./puppeteer.browserfetcher.candownload.md)             |           | Initiates a HEAD request to check if the revision is available. |
-| [download(revision, progressCallback)](./puppeteer.browserfetcher.download.md) |           | Initiates a GET request to download the revision from the host. |
-| [host()](./puppeteer.browserfetcher.host.md)                                   |           |                                                                 |
-| [localRevisions()](./puppeteer.browserfetcher.localrevisions.md)               |           |                                                                 |
-| [platform()](./puppeteer.browserfetcher.platform.md)                           |           |                                                                 |
-| [product()](./puppeteer.browserfetcher.product.md)                             |           |                                                                 |
-| [remove(revision)](./puppeteer.browserfetcher.remove.md)                       |           |                                                                 |
-| [revisionInfo(revision)](./puppeteer.browserfetcher.revisioninfo.md)           |           |                                                                 |
+| Method                                                                         | Modifiers | Description                                                                                                                                |
+| ------------------------------------------------------------------------------ | --------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
+| [canDownload(revision)](./puppeteer.browserfetcher.candownload.md)             |           | Initiates a HEAD request to check if the revision is available.                                                                            |
+| [download(revision, progressCallback)](./puppeteer.browserfetcher.download.md) |           | Initiates a GET request to download the revision from the host.                                                                            |
+| [host()](./puppeteer.browserfetcher.host.md)                                   |           | The download host being used.                                                                                                              |
+| [localRevisions()](./puppeteer.browserfetcher.localrevisions.md)               |           |                                                                                                                                            |
+| [platform()](./puppeteer.browserfetcher.platform.md)                           |           | Returns the current <code>Platform</code>, which is one of <code>mac</code>, <code>linux</code>, <code>win32</code> or <code>win64</code>. |
+| [product()](./puppeteer.browserfetcher.product.md)                             |           | Returns the current <code>Product</code>, which is one of <code>chrome</code> or <code>firefox</code>.                                     |
+| [remove(revision)](./puppeteer.browserfetcher.remove.md)                       |           |                                                                                                                                            |
+| [revisionInfo(revision)](./puppeteer.browserfetcher.revisioninfo.md)           |           |                                                                                                                                            |
diff --git a/docs/api/puppeteer.browserfetcher.platform.md b/docs/api/puppeteer.browserfetcher.platform.md
@@ -4,6 +4,8 @@ sidebar_label: BrowserFetcher.platform
 
 # BrowserFetcher.platform() method
 
+Returns the current `Platform`, which is one of `mac`, `linux`, `win32` or `win64`.
+
 #### Signature:
 
 ```typescript
@@ -15,5 +17,3 @@ class BrowserFetcher {
 **Returns:**
 
 [Platform](./puppeteer.platform.md)
-
-Returns the current `Platform`, which is one of `mac`, `linux`, `win32` or `win64`.
diff --git a/docs/api/puppeteer.browserfetcher.product.md b/docs/api/puppeteer.browserfetcher.product.md
@@ -4,6 +4,8 @@ sidebar_label: BrowserFetcher.product
 
 # BrowserFetcher.product() method
 
+Returns the current `Product`, which is one of `chrome` or `firefox`.
+
 #### Signature:
 
 ```typescript
@@ -15,5 +17,3 @@ class BrowserFetcher {
 **Returns:**
 
 [Product](./puppeteer.product.md)
-
-Returns the current `Product`, which is one of `chrome` or `firefox`.
diff --git a/docs/api/puppeteer.browserlaunchargumentoptions.md b/docs/api/puppeteer.browserlaunchargumentoptions.md
@@ -17,7 +17,7 @@ export interface BrowserLaunchArgumentOptions
 | Property      | Modifiers             | Type             | Description                                                                                                                                                   | Default            |
 | ------------- | --------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
 | args          | <code>optional</code> | string\[\]       | Additional command line arguments to pass to the browser instance.                                                                                            |                    |
-| debuggingPort | <code>optional</code> | number           |                                                                                                                                                               |                    |
+| debuggingPort | <code>optional</code> | number           | Specify the debugging port number to use                                                                                                                      |                    |
 | devtools      | <code>optional</code> | boolean          | Whether to auto-open a DevTools panel for each tab. If this is set to <code>true</code>, then <code>headless</code> will be forced to <code>false</code>.     | <code>false</code> |
 | headless      | <code>optional</code> | boolean \| 'new' | Whether to run the browser in headless mode.                                                                                                                  | <code>true</code>  |
 | userDataDir   | <code>optional</code> | string           | Path to a user data directory. [see the Chromium docs](https://chromium.googlesource.com/chromium/src/+/refs/heads/main/docs/user_data_dir.md) for more info. |                    |
diff --git a/docs/api/puppeteer.consolemessage.args.md b/docs/api/puppeteer.consolemessage.args.md
@@ -4,6 +4,8 @@ sidebar_label: ConsoleMessage.args
 
 # ConsoleMessage.args() method
 
+An array of arguments passed to the console.
+
 #### Signature:
 
 ```typescript
@@ -15,5 +17,3 @@ class ConsoleMessage {
 **Returns:**
 
 [JSHandle](./puppeteer.jshandle.md)\[\]
-
-An array of arguments passed to the console.
diff --git a/docs/api/puppeteer.consolemessage.location.md b/docs/api/puppeteer.consolemessage.location.md
@@ -4,6 +4,8 @@ sidebar_label: ConsoleMessage.location
 
 # ConsoleMessage.location() method
 
+The location of the console message.
+
 #### Signature:
 
 ```typescript
@@ -15,5 +17,3 @@ class ConsoleMessage {
 **Returns:**
 
 [ConsoleMessageLocation](./puppeteer.consolemessagelocation.md)
-
-The location of the console message.
diff --git a/docs/api/puppeteer.consolemessage.md b/docs/api/puppeteer.consolemessage.md
@@ -20,10 +20,10 @@ export declare class ConsoleMessage
 
 ## Methods
 
-| Method                                                   | Modifiers | Description |
-| -------------------------------------------------------- | --------- | ----------- |
-| [args()](./puppeteer.consolemessage.args.md)             |           |             |
-| [location()](./puppeteer.consolemessage.location.md)     |           |             |
-| [stackTrace()](./puppeteer.consolemessage.stacktrace.md) |           |             |
-| [text()](./puppeteer.consolemessage.text.md)             |           |             |
-| [type()](./puppeteer.consolemessage.type.md)             |           |             |
+| Method                                                   | Modifiers | Description                                                 |
+| -------------------------------------------------------- | --------- | ----------------------------------------------------------- |
+| [args()](./puppeteer.consolemessage.args.md)             |           | An array of arguments passed to the console.                |
+| [location()](./puppeteer.consolemessage.location.md)     |           | The location of the console message.                        |
+| [stackTrace()](./puppeteer.consolemessage.stacktrace.md) |           | The array of locations on the stack of the console message. |
+| [text()](./puppeteer.consolemessage.text.md)             |           | The text of the console message.                            |
+| [type()](./puppeteer.consolemessage.type.md)             |           | The type of the console message.                            |
diff --git a/docs/api/puppeteer.consolemessage.stacktrace.md b/docs/api/puppeteer.consolemessage.stacktrace.md
@@ -4,6 +4,8 @@ sidebar_label: ConsoleMessage.stackTrace
 
 # ConsoleMessage.stackTrace() method
 
+The array of locations on the stack of the console message.
+
 #### Signature:
 
 ```typescript
@@ -15,5 +17,3 @@ class ConsoleMessage {
 **Returns:**
 
 [ConsoleMessageLocation](./puppeteer.consolemessagelocation.md)\[\]
-
-The array of locations on the stack of the console message.
diff --git a/docs/api/puppeteer.consolemessage.text.md b/docs/api/puppeteer.consolemessage.text.md
@@ -4,6 +4,8 @@ sidebar_label: ConsoleMessage.text
 
 # ConsoleMessage.text() method
 
+The text of the console message.
+
 #### Signature:
 
 ```typescript
@@ -15,5 +17,3 @@ class ConsoleMessage {
 **Returns:**
 
 string
-
-The text of the console message.
diff --git a/docs/api/puppeteer.consolemessage.type.md b/docs/api/puppeteer.consolemessage.type.md
@@ -4,6 +4,8 @@ sidebar_label: ConsoleMessage.type
 
 # ConsoleMessage.type() method
 
+The type of the console message.
+
 #### Signature:
 
 ```typescript
@@ -15,5 +17,3 @@ class ConsoleMessage {
 **Returns:**
 
 [ConsoleMessageType](./puppeteer.consolemessagetype.md)
-
-The type of the console message.
diff --git a/docs/api/puppeteer.coverage.md b/docs/api/puppeteer.coverage.md
@@ -51,9 +51,9 @@ console.log(`Bytes used: ${(usedBytes / totalBytes) * 100}%`);
 
 ## Methods
 
-| Method                                                                | Modifiers | Description |
-| --------------------------------------------------------------------- | --------- | ----------- |
-| [startCSSCoverage(options)](./puppeteer.coverage.startcsscoverage.md) |           |             |
-| [startJSCoverage(options)](./puppeteer.coverage.startjscoverage.md)   |           |             |
-| [stopCSSCoverage()](./puppeteer.coverage.stopcsscoverage.md)          |           |             |
-| [stopJSCoverage()](./puppeteer.coverage.stopjscoverage.md)            |           |             |
+| Method                                                                | Modifiers | Description                                                                 |
+| --------------------------------------------------------------------- | --------- | --------------------------------------------------------------------------- |
+| [startCSSCoverage(options)](./puppeteer.coverage.startcsscoverage.md) |           |                                                                             |
+| [startJSCoverage(options)](./puppeteer.coverage.startjscoverage.md)   |           |                                                                             |
+| [stopCSSCoverage()](./puppeteer.coverage.stopcsscoverage.md)          |           | Promise that resolves to the array of coverage reports for all stylesheets. |
+| [stopJSCoverage()](./puppeteer.coverage.stopjscoverage.md)            |           | Promise that resolves to the array of coverage reports for all scripts.     |
diff --git a/docs/api/puppeteer.coverage.stopcsscoverage.md b/docs/api/puppeteer.coverage.stopcsscoverage.md
@@ -4,6 +4,8 @@ sidebar_label: Coverage.stopCSSCoverage
 
 # Coverage.stopCSSCoverage() method
 
+Promise that resolves to the array of coverage reports for all stylesheets.
+
 #### Signature:
 
 ```typescript
@@ -16,8 +18,6 @@ class Coverage {
 
 Promise&lt;[CoverageEntry](./puppeteer.coverageentry.md)\[\]&gt;
 
-Promise that resolves to the array of coverage reports for all stylesheets.
-
 ## Remarks
 
 CSS Coverage doesn't include dynamically injected style tags without sourceURLs.
diff --git a/docs/api/puppeteer.coverage.stopjscoverage.md b/docs/api/puppeteer.coverage.stopjscoverage.md
@@ -4,6 +4,8 @@ sidebar_label: Coverage.stopJSCoverage
 
 # Coverage.stopJSCoverage() method
 
+Promise that resolves to the array of coverage reports for all scripts.
+
 #### Signature:
 
 ```typescript
@@ -16,8 +18,6 @@ class Coverage {
 
 Promise&lt;[JSCoverageEntry](./puppeteer.jscoverageentry.md)\[\]&gt;
 
-Promise that resolves to the array of coverage reports for all scripts.
-
 ## Remarks
 
 JavaScript Coverage doesn't include anonymous scripts by default. However, scripts with sourceURLs are reported.
diff --git a/docs/api/puppeteer.customqueryhandler.md b/docs/api/puppeteer.customqueryhandler.md
@@ -12,7 +12,7 @@ export interface CustomQueryHandler
 
 ## Properties
 
-| Property | Modifiers             | Type                                                      | Description | Default |
-| -------- | --------------------- | --------------------------------------------------------- | ----------- | ------- |
-| queryAll | <code>optional</code> | (node: Node, selector: string) =&gt; Iterable&lt;Node&gt; |             |         |
-| queryOne | <code>optional</code> | (node: Node, selector: string) =&gt; Node \| null         |             |         |
+| Property | Modifiers             | Type                                                      | Description                                                                                                                                                                                   | Default |
+| -------- | --------------------- | --------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
+| queryAll | <code>optional</code> | (node: Node, selector: string) =&gt; Iterable&lt;Node&gt; | Searches for some [Nodes](https://developer.mozilla.org/en-US/docs/Web/API/Node) matching the given <code>selector</code> from [node](https://developer.mozilla.org/en-US/docs/Web/API/Node). |         |
+| queryOne | <code>optional</code> | (node: Node, selector: string) =&gt; Node \| null         | Searches for a [Node](https://developer.mozilla.org/en-US/docs/Web/API/Node) matching the given <code>selector</code> from [node](https://developer.mozilla.org/en-US/docs/Web/API/Node).     |         |
diff --git a/docs/api/puppeteer.dialog.accept.md b/docs/api/puppeteer.dialog.accept.md
@@ -4,6 +4,8 @@ sidebar_label: Dialog.accept
 
 # Dialog.accept() method
 
+A promise that resolves when the dialog has been accepted.
+
 #### Signature:
 
 ```typescript
@@ -21,5 +23,3 @@ class Dialog {
 **Returns:**
 
 Promise&lt;void&gt;
-
-A promise that resolves when the dialog has been accepted.
diff --git a/docs/api/puppeteer.dialog.defaultvalue.md b/docs/api/puppeteer.dialog.defaultvalue.md
@@ -4,6 +4,8 @@ sidebar_label: Dialog.defaultValue
 
 # Dialog.defaultValue() method
 
+The default value of the prompt, or an empty string if the dialog is not a `prompt`.
+
 #### Signature:
 
 ```typescript
@@ -15,5 +17,3 @@ class Dialog {
 **Returns:**
 
 string
-
-The default value of the prompt, or an empty string if the dialog is not a `prompt`.
diff --git a/docs/api/puppeteer.dialog.dismiss.md b/docs/api/puppeteer.dialog.dismiss.md
@@ -4,6 +4,8 @@ sidebar_label: Dialog.dismiss
 
 # Dialog.dismiss() method
 
+A promise which will resolve once the dialog has been dismissed
+
 #### Signature:
 
 ```typescript
@@ -15,5 +17,3 @@ class Dialog {
 **Returns:**
 
 Promise&lt;void&gt;
-
-A promise which will resolve once the dialog has been dismissed
diff --git a/docs/api/puppeteer.dialog.md b/docs/api/puppeteer.dialog.md
@@ -35,10 +35,10 @@ import puppeteer from 'puppeteer';
 
 ## Methods
 
-| Method                                               | Modifiers | Description |
-| ---------------------------------------------------- | --------- | ----------- |
-| [accept(promptText)](./puppeteer.dialog.accept.md)   |           |             |
-| [defaultValue()](./puppeteer.dialog.defaultvalue.md) |           |             |
-| [dismiss()](./puppeteer.dialog.dismiss.md)           |           |             |
-| [message()](./puppeteer.dialog.message.md)           |           |             |
-| [type()](./puppeteer.dialog.type.md)                 |           |             |
+| Method                                               | Modifiers | Description                                                                                     |
+| ---------------------------------------------------- | --------- | ----------------------------------------------------------------------------------------------- |
+| [accept(promptText)](./puppeteer.dialog.accept.md)   |           | A promise that resolves when the dialog has been accepted.                                      |
+| [defaultValue()](./puppeteer.dialog.defaultvalue.md) |           | The default value of the prompt, or an empty string if the dialog is not a <code>prompt</code>. |
+| [dismiss()](./puppeteer.dialog.dismiss.md)           |           | A promise which will resolve once the dialog has been dismissed                                 |
+| [message()](./puppeteer.dialog.message.md)           |           | The message displayed in the dialog.                                                            |
+| [type()](./puppeteer.dialog.type.md)                 |           | The type of the dialog.                                                                         |
diff --git a/docs/api/puppeteer.dialog.message.md b/docs/api/puppeteer.dialog.message.md
@@ -4,6 +4,8 @@ sidebar_label: Dialog.message
 
 # Dialog.message() method
 
+The message displayed in the dialog.
+
 #### Signature:
 
 ```typescript
@@ -15,5 +17,3 @@ class Dialog {
 **Returns:**
 
 string
-
-The message displayed in the dialog.
diff --git a/docs/api/puppeteer.dialog.type.md b/docs/api/puppeteer.dialog.type.md
@@ -4,6 +4,8 @@ sidebar_label: Dialog.type
 
 # Dialog.type() method
 
+The type of the dialog.
+
 #### Signature:
 
 ```typescript
@@ -15,5 +17,3 @@ class Dialog {
 **Returns:**
 
 Protocol.Page.DialogType
-
-The type of the dialog.
diff --git a/docs/api/puppeteer.frame.childframes.md b/docs/api/puppeteer.frame.childframes.md
@@ -4,6 +4,8 @@ sidebar_label: Frame.childFrames
 
 # Frame.childFrames() method
 
+An array of child frames.
+
 #### Signature:
 
 ```typescript
@@ -15,5 +17,3 @@ class Frame {
 **Returns:**
 
 [Frame](./puppeteer.frame.md)\[\]
-
-An array of child frames.
diff --git a/docs/api/puppeteer.frame.content.md b/docs/api/puppeteer.frame.content.md
@@ -4,6 +4,8 @@ sidebar_label: Frame.content
 
 # Frame.content() method
 
+The full HTML contents of the frame, including the DOCTYPE.
+
 #### Signature:
 
 ```typescript
@@ -15,5 +17,3 @@ class Frame {
 **Returns:**
 
 Promise&lt;string&gt;
-
-The full HTML contents of the frame, including the DOCTYPE.
diff --git a/docs/api/puppeteer.frame.isdetached.md b/docs/api/puppeteer.frame.isdetached.md
@@ -4,6 +4,8 @@ sidebar_label: Frame.isDetached
 
 # Frame.isDetached() method
 
+Is`true` if the frame has been detached. Otherwise, `false`.
+
 #### Signature:
 
 ```typescript
@@ -15,5 +17,3 @@ class Frame {
 **Returns:**
 
 boolean
-
-`true` if the frame has been detached. Otherwise, `false`.
diff --git a/docs/api/puppeteer.frame.isoopframe.md b/docs/api/puppeteer.frame.isoopframe.md
@@ -4,6 +4,8 @@ sidebar_label: Frame.isOOPFrame
 
 # Frame.isOOPFrame() method
 
+Is `true` if the frame is an out-of-process (OOP) frame. Otherwise, `false`.
+
 #### Signature:
 
 ```typescript
@@ -15,5 +17,3 @@ class Frame {
 **Returns:**
 
 boolean
-
-`true` if the frame is an out-of-process (OOP) frame. Otherwise, `false`.