Skip to content

docs: Fix errors and standardize frontmatter across all pages#695

Merged
vdusek merged 1 commit intomasterfrom
docs/fix-errors-and-standardize-frontmatter
Apr 2, 2026
Merged

docs: Fix errors and standardize frontmatter across all pages#695
vdusek merged 1 commit intomasterfrom
docs/fix-errors-and-standardize-frontmatter

Conversation

@vdusek
Copy link
Copy Markdown
Contributor

@vdusek vdusek commented Apr 2, 2026

Summary

  • Fix error handling examplesexcept Exception as ApifyApiError was catching all exceptions and shadowing the class name; now properly uses from apify_client.errors import ApifyApiError with except ApifyApiError as err
  • Fix retries page — default retry count corrected from 8 to 4 (matches DEFAULT_MAX_RETRIES); updated outdated min_delay_between_retries_millis to min_delay_between_retries (takes timedelta)
  • Fix convenience methods pagestart() was described as waiting for finish (it doesn't); added missing wait_for_finish() method
  • Fix nested client examples — replaced ty: ignore comments with proper ActorJobStatus.SUCCEEDED enum usage
  • Fix README — updated Quick Start to typed attribute access (actor_call.default_dataset_id), corrected retry count and parameter name
  • Fix comment grammar — "waits" → "wait" in code examples
  • Add description frontmatter to all 20 doc pages for SEO
  • Standardize guide titles to imperative form ("Pass input to an Actor", "Integrate with data libraries", "Use HTTPX as the HTTP client")

🤖 Generated with Claude Code

…ages

Fix several factual errors in docs: wrong error handling pattern (except Exception
as ApifyApiError → except ApifyApiError as err), incorrect default retry count
(8 → 4), outdated parameter name (min_delay_between_retries_millis → min_delay_between_retries),
wrong start() description, outdated README dict access. Add description field to
all frontmatter and standardize guide titles to imperative form.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@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 Apr 2, 2026
@vdusek vdusek self-assigned this Apr 2, 2026
@github-actions github-actions bot added this to the 137th sprint - Tooling team milestone Apr 2, 2026
@vdusek vdusek changed the title docs: fix factual errors and standardize frontmatter across all doc pages docs: Fix errors and standardize frontmatter across all pages Apr 2, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 2, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.84%. Comparing base (2f67a5d) to head (8e6ad44).
⚠️ Report is 2 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #695      +/-   ##
==========================================
+ Coverage   94.79%   94.84%   +0.04%     
==========================================
  Files          45       45              
  Lines        4403     4403              
==========================================
+ Hits         4174     4176       +2     
+ Misses        229      227       -2     
Flag Coverage Δ
integration 94.84% <ø> (+0.04%) ⬆️

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

☔ View full report in Codecov by Sentry.
📢 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 April 2, 2026 07:37
@vdusek vdusek merged commit 64ee8ab into master Apr 2, 2026
26 checks passed
@vdusek vdusek deleted the docs/fix-errors-and-standardize-frontmatter branch April 2, 2026 08:32
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