Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document treq's default behavior to buffer responses #88

Closed
gruns opened this issue Mar 31, 2015 · 1 comment
Closed

Document treq's default behavior to buffer responses #88

gruns opened this issue Mar 31, 2015 · 1 comment
Labels

Comments

@gruns
Copy link

gruns commented Mar 31, 2015

treq's documentation is devoid of explanation of the unbuffered parameter.

No comments, either.

$ grep -riI "unbuffered" treq/
./client.py:        if not kwargs.get('unbuffered', False):
./test/test_client.py:        d = self.client.get('http://www.example.com', unbuffered=True)

The behavior to buffer responses by default differs from t.w.c.Agent, which doesn't. This behavior is unexpected. It should be documented.

Where should it be documented? I'll submit a pull request.

@twm twm added the bug label Mar 14, 2020
@twm
Copy link
Contributor

twm commented Jan 15, 2021

The unbuffered parameter is now documented and used in an example as of #233, so I'm closing this as complete. Thanks!

@twm twm closed this as completed Jan 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants