playwright/docs/src/api
Dmitry Gozman c68f57d2d0
docs: mark optional properties/arguments explicitly with "?" (#13369)
Previously, we were guessing whether something is optional from the
comment (looking for stuff like "defaults to" or "optional").

To remove this error-prone technique, every optional property or
argument (but not option) is explicitly marked with "?".
2022-04-06 19:02:10 -07:00
..
class-accessibility.md docs: fixing example code in accessibility API docs (#12664) 2022-03-23 11:50:35 +01:00
class-android.md feat(android): add androidDevice.options.omitDriverInstall (#13249) 2022-04-02 16:00:38 -07:00
class-androiddevice.md docs: mark optional properties/arguments explicitly with "?" (#13369) 2022-04-06 19:02:10 -07:00
class-androidinput.md docs: document Android and friends (#5415) 2021-02-11 10:31:57 -08:00
class-androidsocket.md docs: use "argument: <type>" notation for events (#5626) 2021-02-25 22:22:47 -08:00
class-androidwebview.md docs: document Android and friends (#5415) 2021-02-11 10:31:57 -08:00
class-apirequest.md docs(fetch): clarify cookie handling (#12892) 2022-03-21 13:20:17 -07:00
class-apirequestcontext.md docs(fetch): clarify cookie handling (#12892) 2022-03-21 13:20:17 -07:00
class-apiresponse.md docs(python): add request API examples (#10512) 2021-11-24 21:55:03 +01:00
class-apiresponseassertions.md docs: asertions.not is a property (#12474) 2022-03-02 15:03:33 -08:00
class-browser.md docs: mark optional properties/arguments explicitly with "?" (#13369) 2022-04-06 19:02:10 -07:00
class-browsercontext.md docs: mark optional properties/arguments explicitly with "?" (#13369) 2022-04-06 19:02:10 -07:00
class-browserserver.md chore: mark methods as js-only, add python-specific methods (#4938) 2021-01-07 16:12:25 -08:00
class-browsertype.md docs: fixes typo (#13094) 2022-04-06 12:00:51 +02:00
class-cdpsession.md docs: mark optional properties/arguments explicitly with "?" (#13369) 2022-04-06 19:02:10 -07:00
class-consolemessage.md docs: delete verification guide (#12698) 2022-03-12 09:32:54 -08:00
class-coverage.md docs: mark optional properties/arguments explicitly with "?" (#13369) 2022-04-06 19:02:10 -07:00
class-dialog.md docs: mark optional properties/arguments explicitly with "?" (#13369) 2022-04-06 19:02:10 -07:00
class-download.md docs: add comments to Promise.all snippets with explanation (#11379) 2022-01-13 10:38:22 -08:00
class-electron.md docs(electron): minimal version (#11792) 2022-02-01 14:45:30 -08:00
class-electronapplication.md docs: mark optional properties/arguments explicitly with "?" (#13369) 2022-04-06 19:02:10 -07:00
class-elementhandle.md docs: mark optional properties/arguments explicitly with "?" (#13369) 2022-04-06 19:02:10 -07:00
class-error.md docs: mark optional properties/arguments explicitly with "?" (#13369) 2022-04-06 19:02:10 -07:00
class-filechooser.md docs: add comments to Promise.all snippets with explanation (#11379) 2022-01-13 10:38:22 -08:00
class-formdata.md docs(api): redo request API for java (#10449) 2021-11-19 16:40:35 -08:00
class-frame.md docs: mark optional properties/arguments explicitly with "?" (#13369) 2022-04-06 19:02:10 -07:00
class-framelocator.md docs: mention locator.nth is zero based (#12750) 2022-03-14 21:06:44 +01:00
class-jshandle.md docs: mark optional properties/arguments explicitly with "?" (#13369) 2022-04-06 19:02:10 -07:00
class-keyboard.md chore: fix docs 2021-08-24 19:49:02 -07:00
class-locator.md docs: mark optional properties/arguments explicitly with "?" (#13369) 2022-04-06 19:02:10 -07:00
class-locatorassertions.md chore: unrelease toHaveScreenshot and screenshotsDir (#13304) 2022-04-05 08:34:51 -07:00
class-logger.md docs: mark optional properties/arguments explicitly with "?" (#13369) 2022-04-06 19:02:10 -07:00
class-mouse.md docs: mark optional properties/arguments explicitly with "?" (#13369) 2022-04-06 19:02:10 -07:00
class-page.md docs: mark optional properties/arguments explicitly with "?" (#13369) 2022-04-06 19:02:10 -07:00
class-pageassertions.md chore: unrelease toHaveScreenshot and screenshotsDir (#13304) 2022-04-05 08:34:51 -07:00
class-playwright.md chore: add link validation for docs (#13047) 2022-03-25 19:30:45 +01:00
class-playwrightassertions.md docs(dotnet): move Expect to method on harness (#12498) 2022-03-03 23:05:13 +01:00
class-playwrightexception.md docs: document PlaywrightException in java (#5743) 2021-03-05 15:32:33 -08:00
class-request.md fix: make Serializable type any (#9059) 2021-09-23 11:06:34 -07:00
class-requestoptions.md docs(api): redo request API for java (#10449) 2021-11-19 16:40:35 -08:00
class-response.md docs: mark optional properties/arguments explicitly with "?" (#13369) 2022-04-06 19:02:10 -07:00
class-route.md docs: mark optional properties/arguments explicitly with "?" (#13369) 2022-04-06 19:02:10 -07:00
class-screenshotassertions.md chore: unrelease toHaveScreenshot and screenshotsDir (#13304) 2022-04-05 08:34:51 -07:00
class-selectors.md docs: mark optional properties/arguments explicitly with "?" (#13369) 2022-04-06 19:02:10 -07:00
class-timeouterror.md docs(element-handle): discourage the element handle use (#10220) 2021-11-10 11:30:25 -08:00
class-touchscreen.md docs: fixed various typos (#5958) 2021-03-26 10:47:16 -07:00
class-tracing.md chore: add link validation for docs (#13047) 2022-03-25 19:30:45 +01:00
class-video.md docs(dotnet): Video and Worker examples (#6581) 2021-05-14 07:50:35 -07:00
class-websocket.md docs: mark optional properties/arguments explicitly with "?" (#13369) 2022-04-06 19:02:10 -07:00
class-websocketframe.md docs: define java specific waitFor* methods (#5315) 2021-02-04 21:15:14 -08:00
class-worker.md docs: mark optional properties/arguments explicitly with "?" (#13369) 2022-04-06 19:02:10 -07:00
csharp.md docs(dotnet): fix incorrect syntax (#8801) 2021-09-09 11:39:26 +02:00
java.md docs(api): add env option to Playwright.create in Java (#7002) 2021-06-09 15:05:51 -07:00
javascript.md feat(locator): implement element locators (#7808) 2021-07-22 21:37:20 -07:00
params.md docs: mark optional properties/arguments explicitly with "?" (#13369) 2022-04-06 19:02:10 -07:00
python.md docs: mark optional properties/arguments explicitly with "?" (#13369) 2022-04-06 19:02:10 -07:00