Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(docs): fix incorrect @returns on getter #6175

Merged
merged 1 commit into from Jul 8, 2020
Merged

chore(docs): fix incorrect @returns on getter #6175

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions new-docs/puppeteer.puppeteer.devices.md
View file
Open in desktop
Expand Up @@ -12,6 +12,7 @@ get devices(): DevicesMap;

## Remarks

A list of devices to be used with `page.emulate(options)`<!-- -->. Actual list of devices can be found in [src/common/DeviceDescriptors.ts](https://github.com/puppeteer/puppeteer/blob/main/src/common/DeviceDescriptors.ts)<!-- -->.

## Example

Expand Down
2 changes: 1 addition & 1 deletion new-docs/puppeteer.puppeteer.errors.md
View file
Open in desktop
Expand Up @@ -14,7 +14,7 @@ get errors(): PuppeteerErrors;

Puppeteer methods might throw errors if they are unable to fulfill a request. For example, `page.waitForSelector(selector[, options])` might fail if the selector doesn't match any nodes during the given timeframe.

For certain types of errors Puppeteer uses specific error classes. These classes are available via `puppeteer.errors`
For certain types of errors Puppeteer uses specific error classes. These classes are available via `puppeteer.errors`<!-- -->.

## Example

Expand Down
6 changes: 4 additions & 2 deletions src/common/Puppeteer.ts
View file
Open in desktop
Expand Up @@ -202,6 +202,8 @@ export class Puppeteer {

/**
* @remarks
* A list of devices to be used with `page.emulate(options)`. Actual list of devices can be found in {@link https://github.com/puppeteer/puppeteer/blob/main/src/common/DeviceDescriptors.ts | src/common/DeviceDescriptors.ts}.
*
* @example
*
* ```js
Expand All @@ -218,7 +220,6 @@ export class Puppeteer {
* })();
* ```
*
* @returns a list of devices to be used with `page.emulate(options)`. Actual list of devices can be found in {@link https://github.com/puppeteer/puppeteer/blob/main/src/common/DeviceDescriptors.ts | src/common/DeviceDescriptors.ts}.
*/
get devices(): DevicesMap {
return devicesMap;
Expand All @@ -232,7 +233,8 @@ export class Puppeteer {
* the selector doesn't match any nodes during the given timeframe.
*
* For certain types of errors Puppeteer uses specific error classes.
* These classes are available via `puppeteer.errors`
* These classes are available via `puppeteer.errors`.
*
* @example
* An example of handling a timeout error:
* ```js
Expand Down