Migrate e2e-test-utils-playwright api to autodoc#76852
Migrate e2e-test-utils-playwright api to autodoc#76852wwahammy wants to merge 1 commit intoWordPress:trunkfrom
Conversation
| /** | ||
| * The Playwright/Jest's [expect](https://jestjs.io/docs/expect) function. | ||
| */ | ||
| const expect = baseExpect; |
There was a problem hiding this comment.
This is a pointless assignment in order to document the expect export. I'm open to better solutions!
|
Warning: Type of PR label mismatch To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.
Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task. |
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
1 participant
What?
Previously, the README.md for the
e2e-test-utils-playwrightpackage appeared to be hand maintained. Because of that they were out of date. This PR migrates the docs to use the autodoc tools used by many other packages.Why?
The README.md api docs were out of date but because they were manually updated.
How?
I moved the docs we already have for the API from the README.md into their corresponding exports. Then I simple replaced the API section of the README with the JS doc tags and the autogenerated JS docs contents.
Use of AI Tools
None.