3b86a9c0e4
docs(markdown): parse :::note's text as children ( #32510 )
2024-09-26 15:16:26 +02:00
a2bdb2fd79
docs: linkify params and options ( #32823 )
...
References https://github.com/microsoft/playwright/issues/32590 .
2024-09-26 05:13:00 -07:00
e5433d0576
chore(docs): validate params/options links ( #32820 )
...
Also supports fully-qualified links like this:
```
[`option: BrowserType.launch.headless`]
```
References https://github.com/microsoft/playwright/issues/32590 .
2024-09-26 01:08:16 -07:00
59700aa9f1
chore: brush up documentation scripts ( #32782 )
...
References #32590 .
2024-09-24 02:51:09 -07:00
74f5ce5489
docs: store parent type reference in documentation.js ( #32215 )
2024-08-19 09:11:20 +02:00
2ae196f708
fix(docs): API types do not extend EventEmitter ( #32124 )
...
Fixes https://github.com/microsoft/playwright/issues/32097
2024-08-12 11:22:48 -07:00
950875f0db
fix(docs): index all deeply nested types ( #31690 )
2024-07-15 16:35:15 +02:00
2b974f2139
docs(clock): update time types in Python/.NET ( #31511 )
2024-07-03 10:46:33 +02:00
f6972c1e23
docs: use long for time in milliseconds ( #31369 )
...
In Java and .NET int is not enough to store millis since epoch.
2024-06-18 10:47:29 -07:00
170c457a61
feat(timers): a stab at fake timers ( #31075 )
2024-05-30 09:38:27 -07: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
1a43adc506
chore: fix docs roll for functions without args follow-up ( #29687 )
2024-02-27 16:40:18 +01:00
03902d8e85
chore: fix docs roll for functions without args ( #29684 )
2024-02-27 07:21:35 -08:00
7de0ccd36e
chore: support await using for close() and dispose() ( #27766 )
...
This change assumes that the user has Node 18 with Symbol.dispose
available.
Fixes https://github.com/microsoft/playwright/issues/27141
2023-10-24 12:25:53 -07:00
0b7f9055a3
chore: fix docs for python and java ( #20962 )
2023-02-16 11:48:38 -08:00
778dd20403
chore(docs): beautify generated types, put options always last ( #20805 )
2023-02-09 20:46:33 -08:00
98e2fe184e
chore(docs): sort members instead of validating ( #20755 )
2023-02-08 09:59:31 -08:00
51782cfa5d
chore: fix docs roll ( #19605 )
2022-12-20 21:19:31 +01:00
bb2a2c7331
fix: render discouraged / deprecated types ( #19596 )
...
Fixes https://github.com/microsoft/playwright/issues/19591
2022-12-20 16:19:07 +01:00
f9a32e0927
chore: follow up to deprecation changes ( #19025 )
2022-11-23 12:32:14 -08:00
f97dcd4c79
docs: annotate deprecated methods ( #19005 )
2022-11-23 08:40:47 -08:00
3fb4b3bbf9
chore: normalize api markdown ( #18942 )
2022-11-21 09:30:32 -08:00
03d2b2ecbf
chore: move doc-specific code into documentation ( #18933 )
2022-11-19 11:26:11 -08:00
0387d96cd5
chore: multiply overloaded options in csharp ( #18818 )
...
This way we'll get the same treatment in docs generator as well as
dotnet api generator.
This also adds non-suffixed aliases for string options, e.g. `Name` in
addition to `NameString` and `NameRegex`.
Fixes #18407 .
2022-11-15 15:46:54 -08:00
bc6617b4ca
chore: verify tab groups in docs during lint ( #18768 )
...
This extracts the logic from playwright.dev so that we get early
warnings.
2022-11-14 13:05:05 -08:00
8292398692
docs: support custom hrefs for api links ( #18514 )
2022-11-02 13:35:51 -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
76abb3a5be
chore: unify tab generation ( #14802 )
2022-06-10 17:34:31 -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
79c8746fd2
docs: add name for screenshot animations option ( #12601 )
2022-03-08 16:02:31 -08:00
ade2171c4b
fix(docs): APIRequest* variable names ( #9621 )
2021-10-19 09:37:17 -07: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
8f1074c76e
docs(test-runner): initial API docs for test runner ( #7732 )
2021-07-22 11:01:18 -07:00
36c5395d2d
chore: rebase documentation and markdown classes from docs ( #7172 )
2021-06-17 08:19:24 +02:00
1b771ed360
docs(python): add Error base class ( #6315 )
2021-04-28 10:41:46 +02:00
e82b546085
docs(dotnet): generate arguments in a consistent order ( #5800 )
2021-04-08 14:21:10 +02:00
c4410d3f4d
Revert "chore(docs): add support for language specific notes ( #5810 )"
...
This bubbled up in Python comments.
2021-03-18 13:50:17 -07:00
693e5699ac
chore(docs): add support for language specific notes ( #5810 )
2021-03-17 15:20:37 +01:00
ea9485ec9a
docs: document PlaywrightException in java ( #5743 )
2021-03-05 15:32:33 -08:00
c12374ea07
feat(docs): improve link validation ( #5394 )
2021-02-10 07:13:14 -08:00
a1b3164864
docs: fix nested union handling ( #5341 )
2021-02-05 16:32:13 -08:00
4b74f5693c
docs: add enum aliases ( #5335 )
2021-02-05 15:28:48 -08:00
cf96b15051
fix(docs): ignore case when validating order of events and methods ( #5309 )
2021-02-04 19:19:38 +01:00
a1d875ed97
docs: make inline refs us parameter name instead of its alias ( #5219 )
2021-01-29 16:02:17 -08:00
21041bc331
docs: support argument overrides ( #5200 )
2021-01-28 17:51:41 -08:00
f2ef7f51b8
Link patching now picks up multiple in single line ( #5163 )
2021-01-27 16:21:27 -08:00
41e394bc22
docs: allow overriding return types ( #5031 )
2021-01-15 16:01:41 -08:00
cac119f3bf
docs: python api review ( #4986 )
2021-01-12 12:14:27 -08:00
Max Schmitt