Repository navigation
Add API docs for streaming #1154
Description
- There are no similar issues or pull requests for this yet.
- I discussed this idea in Expand client docstrings #1152 and feedback is positive.
There is no documentation in either the top level stream or Client.stream, and they are not mentioned in generated documentation. At least a short description of functionality and parameters (pointing to httpx.request if applicable) should be added.
Activity
lovelydinosaur commentedon Aug 10, 2020
So the streaming docs are here... https://www.python-httpx.org/quickstart/#streaming-responses
But yes, they're missing from the API documentation at the moment.
felix-hilden commentedon Aug 10, 2020
Yes, that's what I meant by generated documentation! And thanks for the reference link 👍
[-]Add streaming documentation[/-][+]Add API docs for streaming[/+]