d07f6cfc5c
docs: check that description has an empty line before it ( #32830 )
2024-09-26 06:31:42 -07:00
59700aa9f1
chore: brush up documentation scripts ( #32782 )
...
References #32590 .
2024-09-24 02:51:09 -07:00
950875f0db
fix(docs): index all deeply nested types ( #31690 )
2024-07-15 16:35:15 +02:00
b67b9634c1
chore: remove support for "experimental" from documentation ( #30880 )
...
Also add support for "hidden" and make `generate_types/index` actually
pass tsc checks.
2024-05-20 10:30:32 -07:00
c37dfb379b
docs: make sure usage comes after description when templating ( #26420 )
2023-08-10 14:48:26 -07:00
f97dcd4c79
docs: annotate deprecated methods ( #19005 )
2022-11-23 08:40:47 -08:00
03d2b2ecbf
chore: move doc-specific code into documentation ( #18933 )
2022-11-19 11:26:11 -08:00
9f17ee6871
feat: group filter ( #17646 )
2022-09-28 18:45:01 -07:00
bfd38bf7df
chore: introduce md templates ( #17632 )
2022-09-27 10:29:34 -07:00
0a3cfc1c21
chore: annotate md utils to compile with ts-check ( #17600 )
2022-09-27 09:27:23 -07:00
6181b0dcaf
docs: annotate since ( #15386 )
2022-07-05 17:24:50 -07:00
c86c2e8762
feat: restore toHaveScreenshot as experimental feature ( #13549 )
...
- Restore docs.
- Make `TestConfig.expect` generated.
- Allow experimental properties with "e" marker: `- foo e<float>`.
2022-04-14 13:22:42 -07:00
20dcc45afa
feat: support experimental doc entries ( #13446 )
...
feat: support experimental doc entries
- Params/options/members are marked as experimental in the docs.
- `experimental.d.ts` is generated that contains all types and
includes experimental features.
- `experimental.d.ts` is references in our tests so that we
can test experimental features.
- `fonts` option is restored as experimental.
2022-04-13 16:13:30 -07:00
cef476b89f
docs: support optional methods ( #13415 )
...
So far, these are used in `Reporter`.
2022-04-07 18:51:05 -07:00
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
4123a55be5
chore: generate more types ( #13358 )
...
As a result, fix documentation issues:
- Removed `TestStep.data` that is not a thing.
- Added `TestConfig.name` documentation.
- Refined a lot of optional types in the documentation.
- Aligned `test.fail()` and `test.slow()` docs with `test.skip()`.
- Strict set of docs vs types inconsistensies in the generator
2022-04-06 13:36:20 -07:00
a413c0f94c
docs: restore assertions timeout option in js ( #12467 )
2022-03-02 12:43:16 -08:00
bb5e44fbc4
docs: introduce overloads, generate JSDoc for overloads ( #8485 )
...
- Each overload, e.g. for `page.evaluate`, shows a nice autocomplete doc,
not only the first one.
- We can have multiple overloads directly on the docs page, e.g.
`test.skip(title, fn)` and `test.skip(condition, description)`.
These overloads are internally named `Test.skip#1` and all aliased
to `test.skip`.
2021-08-27 21:57:40 -07:00
fd9c72015f
docs(test runner): API reference for builtin fixtures ( #7805 )
2021-07-22 14:47:12 -07:00
8f1074c76e
docs(test-runner): initial API docs for test runner ( #7732 )
2021-07-22 11:01:18 -07:00
ba652c177f
docs: inline parsing should honor template location ( #6289 )
2021-04-29 21:16:09 -07:00
96e099aca3
docs: use "argument: <type>" notation for events ( #5626 )
2021-02-25 22:22:47 -08:00
0c8d8a3d0f
fix(docs): correctly detect type-only overrides ( #5430 )
2021-02-11 23:43:59 -08:00
d39d2eaf4c
docs: support method overrides ( #5405 )
2021-02-10 14:27:20 -08:00
adeb2348cf
docs: change WebSocket.frame* event type to WebSocketFrame in java ( #5384 )
2021-02-09 12:11:48 -08:00
1db5ef24a8
docs: document electron api ( #5229 )
2021-02-01 11:43:26 -08:00
e71ef7949b
docs: add java traits to some methods ( #5222 ) ( #5243 )
2021-02-01 11:13:13 -08:00
82bb92f103
Revert "docs: add java traits to some methods ( #5222 )"
...
Breaks playwright.dev
2021-01-30 22:15:56 -08:00
9c4668685d
docs: add java traits to some methods ( #5222 )
2021-01-29 19:15:25 -08:00
dbcdf9dcd7
chore(docs): aliases for dotnet/chsarp docs. ( #5162 )
...
Co-authored-by: Yury Semikhatsky <yurys@chromium.org>
2021-01-29 11:08:22 -08:00
21041bc331
docs: support argument overrides ( #5200 )
2021-01-28 17:51:41 -08:00
41e394bc22
docs: allow overriding return types ( #5031 )
2021-01-15 16:01:41 -08:00
4dbbb47583
docs: document Python's expect_event methods ( #4963 )
2021-01-10 21:00:52 -08:00
e67d89747a
chore: update docs to cover python specifics ( #4960 )
2021-01-10 18:18:35 -08:00
114d586f07
chore: add python aliases ( #4949 )
2021-01-08 15:00:14 -08:00
15c0a29526
docs: split nodejs and python links ( #4942 )
2021-01-07 23:37:53 -08:00
54c06a1b45
chore: mark methods as js-only, add python-specific methods ( #4938 )
2021-01-07 16:12:25 -08:00
e56832b646
chore: language-specific members api ( #4936 )
2021-01-07 15:00:04 -08:00
Dmitry Gozman
Max Schmitt
Pavel Feldman
Yury Semikhatsky
Darío Kondratiuk
Anže Vodovnik