From a8661330de98ff9510e396c263c0e2d93f2f0b9a Mon Sep 17 00:00:00 2001 From: Max Schmitt Date: Mon, 19 Jul 2021 12:43:57 +0200 Subject: [PATCH] docs(browser): make Chromium tracing vs. PW tracing more clear (#7713) Co-authored-by: Andrey Lushnikov --- docs/src/api/class-browser.md | 4 ++-- types/types.d.ts | 8 ++++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/src/api/class-browser.md b/docs/src/api/class-browser.md index 2d802dafa4..5912889296 100644 --- a/docs/src/api/class-browser.md +++ b/docs/src/api/class-browser.md @@ -239,7 +239,7 @@ testing frameworks should explicitly create [`method: Browser.newContext`] follo * langs: java, js, python :::note -Tracing is only supported on Chromium-based browsers. +This API controls [Chromium Tracing](https://www.chromium.org/developers/how-tos/trace-event-profiling-tool) which is a low-level chromium-specific debugging tool. API to control [Playwright Tracing](../trace-viewer) could be found [here](./class-tracing). ::: You can use [`method: Browser.startTracing`] and [`method: Browser.stopTracing`] to create a trace file that can @@ -295,7 +295,7 @@ specify custom categories to use instead of default. - returns: <[Buffer]> :::note -Tracing is only supported on Chromium-based browsers. +This API controls [Chromium Tracing](https://www.chromium.org/developers/how-tos/trace-event-profiling-tool) which is a low-level chromium-specific debugging tool. API to control [Playwright Tracing](../trace-viewer) could be found [here](./class-tracing). ::: Returns the buffer with trace data. diff --git a/types/types.d.ts b/types/types.d.ts index 9e199198cb..b560ed5ee4 100644 --- a/types/types.d.ts +++ b/types/types.d.ts @@ -8860,7 +8860,9 @@ export interface Browser extends EventEmitter { }): Promise; /** - * > NOTE: Tracing is only supported on Chromium-based browsers. + * > NOTE: This API controls [Chromium Tracing](https://www.chromium.org/developers/how-tos/trace-event-profiling-tool) + * which is a low-level chromium-specific debugging tool. API to control [Playwright Tracing](../trace-viewer) could be + * found [here](https://playwright.dev/docs/class-tracing). * * You can use [browser.startTracing([page, options])](https://playwright.dev/docs/api/class-browser#browser-start-tracing) * and [browser.stopTracing()](https://playwright.dev/docs/api/class-browser#browser-stop-tracing) to create a trace file @@ -8893,7 +8895,9 @@ export interface Browser extends EventEmitter { }): Promise; /** - * > NOTE: Tracing is only supported on Chromium-based browsers. + * > NOTE: This API controls [Chromium Tracing](https://www.chromium.org/developers/how-tos/trace-event-profiling-tool) + * which is a low-level chromium-specific debugging tool. API to control [Playwright Tracing](../trace-viewer) could be + * found [here](https://playwright.dev/docs/class-tracing). * * Returns the buffer with trace data. */