docs: Fix inaccuracies, unify wording, and expand SDK documentation#921
Open
vdusek wants to merge 1 commit into
Open
docs: Fix inaccuracies, unify wording, and expand SDK documentation#921vdusek wants to merge 1 commit into
vdusek wants to merge 1 commit into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #921 +/- ##
==========================================
- Coverage 86.94% 86.87% -0.07%
==========================================
Files 48 48
Lines 2942 2942
==========================================
- Hits 2558 2556 -2
- Misses 384 386 +2
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
83e5f9b to
547af69
Compare
1c257ae to
b815385
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reviews the SDK documentation against the codebase, fixes verified inaccuracies, unifies wording and structure, and fills several gaps.
Correctness fixes (verified against the code)
Dataset.export_to_csv/export_to_jsondon't exist → documented the realDataset.export_tomethod (content_type='csv'|'json').Actor.start_tasknever existed →Actor.call_task(acceptsWebhook, returnsActorRun).3.10+→3.11+(matchesrequires-python = ">=3.11").Actor.configuration.container_url/container_portdon't exist →web_server_url/web_server_port(the prose contradicted the snippet, which was already correct).SYSTEM_INFOpayload (handlers receiveEventSystemInfoDatawithcpu_info/memory_info),MIGRATINGdata (time_remaining), andConfig→Configuration; each event now links its real data type.APIFY_PERSIST_STORAGE=0example withAPIFY_PURGE_ON_START=0.<ApiLink to="">.04_actor_events.py): fixed a latent runtime bug — passing a Pydantic model as loggingextra=raisesTypeError; now usesevent_data.is_migrating.__main__.pydescription (the shown snippet doesn't configure logging).Consistency & wording
__main.py__→__main__.pytab labels/titles (quick-start, Scrapy guide).force_cloud, "a URL", "Twisted's", missing spaces, …).Additions
12_storage_clients.mdx) + two runnable snippets: defaultSmartApifyStorageClient, single vs. shared request queue,force_cloud, and custom-client setup viaservice_locator. Cross-linked from the storages page and quick-start.StorageClientfromapify.storage_clients.## Conclusionsection to every concept page for consistent structure.Verification
ruff check docs/andty checkpass; the new/edited snippets run to exit code 0. TheDataset.export_toandActor.call_taskcorrections were confirmed by runtime introspection and git history, and theActorLogFormatterApiLink was verified to resolve (a fresh API-ref regen plus a live HTTP 200), so it was kept as-is.