docs: Fix documentation mismatches with actual client behavior#958
Open
vdusek wants to merge 1 commit into
Open
docs: Fix documentation mismatches with actual client behavior#958vdusek wants to merge 1 commit into
vdusek wants to merge 1 commit into
Conversation
vdusek
marked this pull request as ready for review
July 17, 2026 14:27
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #958 +/- ##
=======================================
Coverage 94.64% 94.64%
=======================================
Files 58 58
Lines 5263 5263
=======================================
Hits 4981 4981
Misses 282 282
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:
|
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.
Fixes 12 documentation issues found by an engineering audit, where docs, examples, or docstrings contradict what the client actually does:
HttpxClient) now raisesApifyApiErrorfor error responses instead of returning them raw, and the guide documents this part of thecallcontract (resource clients rely on it, e.g. to translate a 404 into aNonereturn value).impit.Response— it now describes the actual yielded value per method (stream_recordyields adictwith the response undervalue,streamandstream_recordmay yieldNone).ListOfRequestsamong page models exposingtotal/offset/count; it now explains its cursor-based pagination vianext_cursor.%(status_code)s(absent on most records, causing logging errors) and no longer attaches a duplicate handler; the page notes which properties are present on every record./api/client/python/...), fixing 6 links that 404ed on the published site.brotli-python(the Python bindings) instead ofbrotli(the C library).RunClient.resurrectdocstrings cite the realSUCCEEDEDstatus instead of the nonexistentFINISHED.wait_for_finishdocstrings inRunClientandBuildClientspell the terminal status asTIMED-OUT(the real literal) instead ofTIMED_OUT.Runmodel'sdefault_dataset_idattribute instead of the v2-era run dictionary withdefaultDatasetId.fieldsaslist[str]per the signature instead of a comma-separated string.Run | Nonereturn ofcall()instead of accessing attributes on a possibleNone.no_timeoutis capped at 24 hours by the default client instead of claiming it disables the timeout entirely.✍️ Drafted by Claude Code