Skip to content

Commit

Permalink
docs: fix multiline Args documentation (apify#883)
Browse files Browse the repository at this point in the history
Bumps the `@apify/docusaurus-plugin-typedoc-api` package to the version
with patched comment parsing (see
apify/docusaurus-plugin-typedoc-api#37)
  • Loading branch information
barjin authored Jan 8, 2025
1 parent 3f7238d commit 4c5019e
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
6 changes: 3 additions & 3 deletions src/crawlee/crawlers/_playwright/_playwright_crawler.py
Original file line number Diff line number Diff line change
Expand Up @@ -84,12 +84,12 @@ def __init__(
browser_type: The type of browser to launch ('chromium', 'firefox', or 'webkit').
This option should not be used if `browser_pool` is provided.
browser_launch_options: Keyword arguments to pass to the browser launch method. These options are provided
directly to Playwright's `browser_type.launch` method. For more details, refer to the Playwright
documentation: https://playwright.dev/python/docs/api/class-browsertype#browser-type-launch.
directly to Playwright's `browser_type.launch` method. For more details, refer to the
[Playwright documentation](https://playwright.dev/python/docs/api/class-browsertype#browser-type-launch).
This option should not be used if `browser_pool` is provided.
browser_new_context_options: Keyword arguments to pass to the browser new context method. These options
are provided directly to Playwright's `browser.new_context` method. For more details, refer to the
Playwright documentation: https://playwright.dev/python/docs/api/class-browser#browser-new-context.
[Playwright documentation](https://playwright.dev/python/docs/api/class-browser#browser-new-context).
This option should not be used if `browser_pool` is provided.
headless: Whether to run the browser in headless mode.
This option should not be used if `browser_pool` is provided.
Expand Down
2 changes: 1 addition & 1 deletion website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
"typescript": "5.7.2"
},
"dependencies": {
"@apify/docusaurus-plugin-typedoc-api": "^4.3.5",
"@apify/docusaurus-plugin-typedoc-api": "^4.3.6",
"@apify/utilities": "^2.8.0",
"@docusaurus/core": "^3.5.2",
"@docusaurus/mdx-loader": "^3.5.2",
Expand Down
10 changes: 5 additions & 5 deletions website/yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -365,9 +365,9 @@ __metadata:
languageName: node
linkType: hard

"@apify/docusaurus-plugin-typedoc-api@npm:^4.3.5":
version: 4.3.5
resolution: "@apify/docusaurus-plugin-typedoc-api@npm:4.3.5"
"@apify/docusaurus-plugin-typedoc-api@npm:^4.3.6":
version: 4.3.6
resolution: "@apify/docusaurus-plugin-typedoc-api@npm:4.3.6"
dependencies:
"@docusaurus/plugin-content-docs": "npm:^3.5.2"
"@docusaurus/types": "npm:^3.5.2"
Expand All @@ -384,7 +384,7 @@ __metadata:
"@docusaurus/mdx-loader": ^3.5.2
react: ">=18.0.0"
typescript: ^5.0.0
checksum: 10c0/f68d0e6fb3014e7d3777916c061fb2fcc1a83aba43ef06b3c1781cf9aded858c35343247ab90021d0d04b1897fa8d6f091168032c497506e5ab544b29fe8d219
checksum: 10c0/fa5a231de6200c50dc14b8d7b3abb45f8cc90cef46da9fefc43a44d55e9788142f7bb02cd7101c02c67d4ce9f421ef2c36817c45f4c7c7d5d5af3f67f21d8c7f
languageName: node
linkType: hard

Expand Down Expand Up @@ -5754,7 +5754,7 @@ __metadata:
version: 0.0.0-use.local
resolution: "crawlee@workspace:."
dependencies:
"@apify/docusaurus-plugin-typedoc-api": "npm:^4.3.5"
"@apify/docusaurus-plugin-typedoc-api": "npm:^4.3.6"
"@apify/eslint-config-ts": "npm:^0.4.0"
"@apify/tsconfig": "npm:^0.1.0"
"@apify/utilities": "npm:^2.8.0"
Expand Down

0 comments on commit 4c5019e

Please sign in to comment.