docs: generate method signatures in docs #4590
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dgozman
approved these changes
Dec 4, 2020
docs/core-concepts.md
Outdated
| @@ -128,7 +128,7 @@ await frame.fill('#username-input', 'John'); | |||
|
|
|||
| - [class `Page`](./api.md#class-page) | |||
| - [class `Frame`](./api.md#class-frame) | |||
| - [page.frame(options)](./api.md#pageframeoptions) | |||
| - [page.frame(options)](./api.md#pageframeframeselector) | |||
There was a problem hiding this comment.
Update this to [page.frame(frameSelector)].
docs/emulation.md
Outdated
| @@ -183,4 +183,4 @@ await page.emulateMedia({ media: 'print' }); | |||
| #### API reference | |||
|
|
|||
| - [`browser.newContext([options])`](./api.md#browsernewcontextoptions) | |||
| - [`page.emulateMedia([options])`](./api.md#pageemulatemediaoptions) | |||
| - [`page.emulateMedia([options])`](./api.md#pageemulatemediaparams) | |||
There was a problem hiding this comment.
Update this to page.emulateMedia([params]).
docs/api.md
Outdated
| @@ -153,7 +154,7 @@ const { firefox } = require('playwright'); // Or 'chromium' or 'webkit'. | |||
| ``` | |||
|
|
|||
| See [ChromiumBrowser], [FirefoxBrowser] and [WebKitBrowser] for browser-specific features. Note that | |||
| [browserType.connect(options)](#browsertypeconnectoptions) and | |||
| [browserType.connect(options)](#browsertypeconnectparams) and | |||
There was a problem hiding this comment.
Update to [browserType.connect(params)]
docs/api.md
Outdated
| @@ -227,7 +228,7 @@ Indicates that the browser is connected. | |||
| - `httpCredentials` <[Object]> Credentials for [HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication). | |||
| - `username` <[string]> | |||
| - `password` <[string]> | |||
| - `colorScheme` <"light"|"dark"|"no-preference"> Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See [page.emulateMedia(options)](#pageemulatemediaoptions) for more details. Defaults to '`light`'. | |||
| - `colorScheme` <"light"|"dark"|"no-preference"> Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See [page.emulateMedia(options)](#pageemulatemediaparams) for more details. Defaults to '`light`'. | |||
There was a problem hiding this comment.
Update to [page.emulateMedia(params)]
docs/api.md
Outdated
| @@ -302,7 +303,7 @@ Creates a new browser context. It won't share cookies/cache with other browser c | |||
| - `httpCredentials` <[Object]> Credentials for [HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication). | |||
| - `username` <[string]> | |||
| - `password` <[string]> | |||
| - `colorScheme` <"light"|"dark"|"no-preference"> Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See [page.emulateMedia(options)](#pageemulatemediaoptions) for more details. Defaults to '`light`'. | |||
| - `colorScheme` <"light"|"dark"|"no-preference"> Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See [page.emulateMedia(options)](#pageemulatemediaparams) for more details. Defaults to '`light`'. | |||
docs/api.md
Outdated
| @@ -1187,10 +1188,10 @@ not defined. | |||
|
|
|||
| Adds a `<script>` tag into the page with the desired url or content. | |||
|
|
|||
| Shortcut for [page.mainFrame().addScriptTag(options)](#frameaddscripttagoptions). | |||
| Shortcut for [page.mainFrame().addScriptTag(options)](#frameaddscripttagscript). | |||
There was a problem hiding this comment.
Update this to [page.mainFrame().addScriptTag(script)].
docs/api.md
Outdated
| @@ -1199,14 +1200,14 @@ Shortcut for [page.mainFrame().addScriptTag(options)](#frameaddscripttagoptions) | |||
| Adds a `<link rel="stylesheet">` tag into the page with the desired url or a `<style type="text/css">` tag with the | |||
| content. | |||
|
|
|||
| Shortcut for [page.mainFrame().addStyleTag(options)](#frameaddstyletagoptions). | |||
| Shortcut for [page.mainFrame().addStyleTag(options)](#frameaddstyletagstyle). | |||
There was a problem hiding this comment.
Update this to [page.mainFrame().addStyleTag(style)].
docs/api.md
Outdated
| @@ -4834,7 +4835,7 @@ some differences for Linux users. | |||
| - `httpCredentials` <[Object]> Credentials for [HTTP authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication). | |||
| - `username` <[string]> | |||
| - `password` <[string]> | |||
| - `colorScheme` <"light"|"dark"|"no-preference"> Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See [page.emulateMedia(options)](#pageemulatemediaoptions) for more details. Defaults to '`light`'. | |||
| - `colorScheme` <"light"|"dark"|"no-preference"> Emulates `'prefers-colors-scheme'` media feature, supported values are `'light'`, `'dark'`, `'no-preference'`. See [page.emulateMedia(options)](#pageemulatemediaparams) for more details. Defaults to '`light`'. | |||
There was a problem hiding this comment.
Update this to [page.emulateMedia(params)].
pavelfeldman
force-pushed
the
params_3
branch
from
3744df3 to
4394bd7
Compare
pavelfeldman
force-pushed
the
params_3
branch
from
4394bd7 to
ef40aac
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.