docs: clarify the path attribute of InstalledBrowser (#10588)

puppeteer · Jul 19, 2023 · 54c6ff2 · 54c6ff2
1 parent 830f926
commit 54c6ff2
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 6 deletions.
diff --git a/docs/browsers-api/browsers.installedbrowser.md b/docs/browsers-api/browsers.installedbrowser.md
@@ -12,9 +12,9 @@ export interface InstalledBrowser
 
 ## Properties
 
-| Property | Modifiers | Type                                             | Description | Default |
-| -------- | --------- | ------------------------------------------------ | ----------- | ------- |
-| browser  |           | [Browser](./browsers.browser.md)                 |             |         |
-| buildId  |           | string                                           |             |         |
-| path     |           | string                                           |             |         |
-| platform |           | [BrowserPlatform](./browsers.browserplatform.md) |             |         |
+| Property | Modifiers | Type                                             | Description                                                                                                                                               | Default |
+| -------- | --------- | ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
+| browser  |           | [Browser](./browsers.browser.md)                 |                                                                                                                                                           |         |
+| buildId  |           | string                                           |                                                                                                                                                           |         |
+| path     |           | string                                           | Path to the root of the installation folder. Use [computeExecutablePath()](./browsers.computeexecutablepath.md) to get the path to the executable binary. |         |
+| platform |           | [BrowserPlatform](./browsers.browserplatform.md) |                                                                                                                                                           |         |
diff --git a/packages/browsers/src/Cache.ts b/packages/browsers/src/Cache.ts
@@ -23,6 +23,10 @@ import {Browser, BrowserPlatform} from './browser-data/browser-data.js';
  * @public
  */
 export interface InstalledBrowser {
+  /**
+   * Path to the root of the installation folder. Use
+   * {@link computeExecutablePath} to get the path to the executable binary.
+   */
   path: string;
   browser: Browser;
   buildId: string;