docs: Fix documentation mismatches with actual client behavior - #958
Conversation
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:
|
| <TabItem value="conda-forge" label="conda-forge"> | ||
| ```bash | ||
| conda install conda-forge::apify-client conda-forge::brotli | ||
| conda install conda-forge::apify-client conda-forge::brotli-python |
There was a problem hiding this comment.
Conda forge does not have any notion of extras dependencies. So I am not sure this will work. It would require some testing. Maybe better to drop all brotli-related advice until tested.
I created a follow-up:
conda-forge/apify-client-feedstock#3
There was a problem hiding this comment.
Yes, it seems Conda-forge doesn't recognize the extras, so installing Brotli directly is the equivalent, isn't it?
Maybe I can put an additional note there to clarify that.
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