Skip to content

docs: Fix stale and inaccurate documentation#2081

Merged
vdusek merged 1 commit into
masterfrom
docs/fix-audit-doc-findings
Jul 21, 2026
Merged

docs: Fix stale and inaccurate documentation#2081
vdusek merged 1 commit into
masterfrom
docs/fix-audit-doc-findings

Conversation

@vdusek

@vdusek vdusek commented Jul 20, 2026

Copy link
Copy Markdown
Collaborator

Fixes four documentation inaccuracies surfaced by the engineering audit:

  • README.mdBeautifulSoupCrawler no longer defaults to HttpxHttpClient. Updated the stated default to ImpitHttpClient, matching BasicCrawler.
  • Dataset.push_data — the docstring claimed a hard 9MB per-object limit, but no local storage client enforces any size limit. Clarified that local clients impose no limit and the 9MB per-object cap applies only to remote clients such as the Apify platform.
  • EnqueueLinksKwargs.strategy — the docstring described only link extraction (enqueue_links), but the field is inherited by add_requests, which filters explicitly provided requests. Reworded to cover both, and corrected the default note (same-hostname is the default for enqueue_links).
  • Introduction tutorial — the "Limit your crawls" section sets max_requests_per_crawl=10 but the prose said "after the 20th request". Fixed to "10th".

Docstring and prose only, no behavior change.

✍️ Drafted by Claude Code

@vdusek vdusek added t-tooling Issues with this label are in the ownership of the tooling team. adhoc Ad-hoc unplanned task added during the sprint. labels Jul 20, 2026
@vdusek vdusek self-assigned this Jul 20, 2026
@github-actions github-actions Bot added this to the 145th sprint - Tooling team milestone Jul 20, 2026
@codecov

codecov Bot commented Jul 20, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.48%. Comparing base (c864b96) to head (0f950af).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2081   +/-   ##
=======================================
  Coverage   93.47%   93.48%           
=======================================
  Files         181      181           
  Lines       12552    12552           
=======================================
+ Hits        11733    11734    +1     
+ Misses        819      818    -1     
Flag Coverage Δ
unit 93.48% <100.00%> (+<0.01%) ⬆️

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 requested a review from Pijukatel July 21, 2026 06:29
@vdusek
vdusek marked this pull request as ready for review July 21, 2026 06:29
@vdusek
vdusek merged commit 8af5498 into master Jul 21, 2026
36 checks passed
@vdusek
vdusek deleted the docs/fix-audit-doc-findings branch July 21, 2026 07:03
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.

3 participants