From 1014abc087e8bc549697fbc688dd332af4ec6959 Mon Sep 17 00:00:00 2001 From: Alex Rudenko Date: Wed, 29 Nov 2023 14:29:13 +0100 Subject: [PATCH] docs: fixing docs (#11460) --- docs/api/puppeteer.browser.md | 2 +- docs/api/puppeteer.browser.wsendpoint.md | 4 ++-- packages/puppeteer-core/src/api/Browser.ts | 4 ++-- tools/docgen/src/custom_markdown_documenter.ts | 2 -- website/src/theme/SearchMetadata/index.js | 1 - 5 files changed, 5 insertions(+), 8 deletions(-) diff --git a/docs/api/puppeteer.browser.md b/docs/api/puppeteer.browser.md index f56a7335eac..289e1f67c63 100644 --- a/docs/api/puppeteer.browser.md +++ b/docs/api/puppeteer.browser.md @@ -78,4 +78,4 @@ await browser2.close(); | [userAgent()](./puppeteer.browser.useragent.md) | |

Gets this [browser's](./puppeteer.browser.md) original user agent.

[Pages](./puppeteer.page.md) can override the user agent with [Page.setUserAgent()](./puppeteer.page.setuseragent.md).

| | [version()](./puppeteer.browser.version.md) | |

Gets a string representing this [browser's](./puppeteer.browser.md) name and version.

For headless browser, this is similar to "HeadlessChrome/61.0.3153.0". For non-headless or new-headless, this is similar to "Chrome/61.0.3153.0". For Firefox, it is similar to "Firefox/116.0a1".

The format of [Browser.version()](./puppeteer.browser.version.md) might change with future releases of browsers.

| | [waitForTarget(predicate, options)](./puppeteer.browser.waitfortarget.md) | |

Waits until a [target](./puppeteer.target.md) matching the given predicate appears and returns it.

This will look all open [browser contexts](./puppeteer.browsercontext.md).

| -| [wsEndpoint()](./puppeteer.browser.wsendpoint.md) | |

Gets the WebSocket URL to connect to this [browser](./puppeteer.browser.md).

This is usually used with [Puppeteer.connect()](./puppeteer.puppeteer.connect.md).

You can find the debugger URL (webSocketDebuggerUrl) from http://${host}:${port}/json/version.

See [browser endpoint](https://chromedevtools.github.io/devtools-protocol/#how-do-i-access-the-browser-target) for more information.

| +| [wsEndpoint()](./puppeteer.browser.wsendpoint.md) | |

Gets the WebSocket URL to connect to this [browser](./puppeteer.browser.md).

This is usually used with [Puppeteer.connect()](./puppeteer.puppeteer.connect.md).

You can find the debugger URL (webSocketDebuggerUrl) from http://HOST:PORT/json/version.

See [browser endpoint](https://chromedevtools.github.io/devtools-protocol/#how-do-i-access-the-browser-target) for more information.

| diff --git a/docs/api/puppeteer.browser.wsendpoint.md b/docs/api/puppeteer.browser.wsendpoint.md index 496719f5279..eb11ec5bf27 100644 --- a/docs/api/puppeteer.browser.wsendpoint.md +++ b/docs/api/puppeteer.browser.wsendpoint.md @@ -8,7 +8,7 @@ Gets the WebSocket URL to connect to this [browser](./puppeteer.browser.md). This is usually used with [Puppeteer.connect()](./puppeteer.puppeteer.connect.md). -You can find the debugger URL (`webSocketDebuggerUrl`) from `http://${host}:${port}/json/version`. +You can find the debugger URL (`webSocketDebuggerUrl`) from `http://HOST:PORT/json/version`. See [browser endpoint](https://chromedevtools.github.io/devtools-protocol/#how-do-i-access-the-browser-target) for more information. @@ -26,4 +26,4 @@ string ## Remarks -The format is always `ws://${host}:${port}/devtools/browser/`. +The format is always `ws://HOST:PORT/devtools/browser/`. diff --git a/packages/puppeteer-core/src/api/Browser.ts b/packages/puppeteer-core/src/api/Browser.ts index ddc3aba8722..a664a410406 100644 --- a/packages/puppeteer-core/src/api/Browser.ts +++ b/packages/puppeteer-core/src/api/Browser.ts @@ -300,13 +300,13 @@ export abstract class Browser extends EventEmitter { * This is usually used with {@link Puppeteer.connect}. * * You can find the debugger URL (`webSocketDebuggerUrl`) from - * `http://${host}:${port}/json/version`. + * `http://HOST:PORT/json/version`. * * See {@link * https://chromedevtools.github.io/devtools-protocol/#how-do-i-access-the-browser-target * | browser endpoint} for more information. * - * @remarks The format is always `ws://${host}:${port}/devtools/browser/`. + * @remarks The format is always `ws://HOST:PORT/devtools/browser/`. */ abstract wsEndpoint(): string; diff --git a/tools/docgen/src/custom_markdown_documenter.ts b/tools/docgen/src/custom_markdown_documenter.ts index 2c5586c3873..ab919414ccc 100644 --- a/tools/docgen/src/custom_markdown_documenter.ts +++ b/tools/docgen/src/custom_markdown_documenter.ts @@ -149,7 +149,6 @@ export class MarkdownDocumenter { outputFolder: this._outputFolder, documenter: new MarkdownDocumenterAccessor({ getLinkForApiItem: (apiItem: ApiItem) => { - console.log(apiItem); return this._getLinkFilenameForApiItem(apiItem); }, }), @@ -157,7 +156,6 @@ export class MarkdownDocumenter { }); } - console.log(); this._deleteOldOutputFiles(); this._writeApiItemPage(this._apiModel.members[0]!); diff --git a/website/src/theme/SearchMetadata/index.js b/website/src/theme/SearchMetadata/index.js index 59b23c083ea..692c3bd912f 100644 --- a/website/src/theme/SearchMetadata/index.js +++ b/website/src/theme/SearchMetadata/index.js @@ -10,7 +10,6 @@ class MonotonicCountMap { #map = new Map(); get(key) { - console.log(key); let counter = this.#map.get(key); if (!counter) { counter = ++this.#counter;