Skip to content

docs: unify crawl caps and fix the runnable code examples#1002

Merged
vdusek merged 3 commits into
masterfrom
fix/docs-runnable-examples
Jun 19, 2026
Merged

docs: unify crawl caps and fix the runnable code examples#1002
vdusek merged 3 commits into
masterfrom
fix/docs-runnable-examples

Conversation

@vdusek

@vdusek vdusek commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

Fixes the "Run on Apify" examples in the Python SDK guides.

  • Lower the page cap from 50 to 10 across all crawling examples, so the browser-based ones finish within the 180s runnable-demo timeout.
  • Selenium: slim the runnable example to a plain crawler (the full version was too large to encode into the Run-on-Apify URL and failed with HTTP 414), and move the proxy-auth extension into the "Using Apify Proxy" section as a separate, non-runnable extension snippet.
  • Browser Use: make it non-runnable (it needs an LLM API key the shared runner cannot provide), with a comment explaining why. Same note added to the Scrapy and Scrapling-browser examples.
  • Keep both Scrapling examples runnable.
  • Pydantic: log a readable validation summary and fail cleanly via Actor.fail instead of re-raising into a raw traceback.

Lower the page cap from 50 to 10 across all crawling examples so the browser-based ones finish within the runnable-demo timeout. Make Selenium (snippet too large for the Run-on-Apify URL) and Browser Use (needs an LLM API key) non-runnable with explanatory comments, keep both Scrapling examples runnable, and have the Pydantic example fail cleanly via `Actor.fail` instead of re-raising into a raw traceback.
@vdusek vdusek added adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team. labels Jun 18, 2026
@vdusek vdusek self-assigned this Jun 18, 2026
@github-actions github-actions Bot added this to the 143rd sprint - Tooling team milestone Jun 18, 2026
@codecov

codecov Bot commented Jun 18, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.61%. Comparing base (53122e4) to head (f8e1767).
⚠️ Report is 5 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1002      +/-   ##
==========================================
+ Coverage   90.51%   91.61%   +1.09%     
==========================================
  Files          49       49              
  Lines        3132     3171      +39     
==========================================
+ Hits         2835     2905      +70     
+ Misses        297      266      -31     
Flag Coverage Δ
e2e 35.69% <ø> (-0.45%) ⬇️
integration 56.41% <ø> (-0.71%) ⬇️
unit 80.51% <ø> (+1.23%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@vdusek vdusek marked this pull request as ready for review June 18, 2026 13:08
@vdusek vdusek requested a review from szaganek as a code owner June 18, 2026 13:08
@vdusek vdusek changed the title docs: unify crawl caps and fix runnable examples docs: unify crawl caps and fix the runnable code examples Jun 18, 2026
@vdusek vdusek requested a review from Pijukatel June 18, 2026 13:31
Comment thread docs/03_guides/04_selenium.mdx Outdated
Comment thread docs/03_guides/04_selenium.mdx Outdated
Comment thread docs/03_guides/04_selenium.mdx Outdated
@vdusek vdusek merged commit 85ac293 into master Jun 19, 2026
28 checks passed
@vdusek vdusek deleted the fix/docs-runnable-examples branch June 19, 2026 07:36
vdusek added a commit that referenced this pull request Jun 19, 2026
Backports the documentation fixes from #1002 into the v3 versioned docs
(`website/versioned_docs/version-3.4/`). The original PR only updated
the next (`docs/`) docs, so the released v3 guides were left out of
sync.

The changes were applied by extracting #1002's diff and re-pointing it
at the versioned tree. Every touched file is now byte-identical to its
`docs/` counterpart.

What it carries over:
- Lower the page cap from 50 to 10 across all crawling examples, so the
browser-based ones finish within the 180s runnable-demo timeout.
- Selenium: slim the runnable example to a plain crawler, and move the
proxy-auth extension into a separate, non-runnable snippet
(`code/04_selenium_proxy.py`).
- Browser Use: make it non-runnable (needs an LLM API key the shared
runner can't provide); same note added to the Scrapy and
Scrapling-browser examples.
- Pydantic: log a readable validation summary and fail cleanly via
`Actor.fail`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants