docs(browser): make Chromium tracing vs. PW tracing more clear (#7713)

Co-authored-by: Andrey Lushnikov <aslushnikov@gmail.com>
This commit is contained in:
Max Schmitt 2021-07-19 12:43:57 +02:00 committed by GitHub
parent 4617bc4baf
commit a8661330de
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 4 deletions

View File

@ -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.

8
types/types.d.ts vendored
View File

@ -8860,7 +8860,9 @@ export interface Browser extends EventEmitter {
}): Promise<Page>;
/**
* > 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<void>;
/**
* > 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.
*/