Repository navigation
docs: document gzip default and brotli extra for request compression - #1209
Merged
vdusek merged 3 commits intoNov 9, 2026
Merged
Conversation
github-actions
Bot
added
the
t-tooling
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.
Summary
Closes #1179.
The
compressiondocstring onApifyClient/ApifyClientAsyncdid not say what the default is or that'brotli'needs an optional extra. That made the difference from the JS client (which defaults to brotli vianode:zlib) hard to discover.This updates the sync docstring (copied to async via
poe fix-docstrings) to state:'gzip''brotli'needspip install "apify-client[brotli]"No behavior change.
Test plan
uv run poe fix-docstringssynced async from syncuv run poe lint(ruff format + check) passesApifyClient/ApifyClientAsyncAI assistance: drafted with Cursor; docstring wording reviewed against CONTRIBUTING (describes current behavior only) and the recommendation in #1179.