search

basecamp / thruster

MIT License
672 stars 16 forks source link

Clarify HTTP_READ_TIMEOUT documentation #15

Closed alexspeller closed 2 months ago

alexspeller commented 3 months ago

The HTTP_READ_TIMEOUT option documentation implies that the timeout is only for request headers, which usually will be a small amount of data.

However, if you allow uploads of large amounts of data, the request body might be large and therefore take longer for the request to complete, especially if the upload bandwidth is low.

I've made a very small change to the HTTP_READ_TIMEOUT option documentation to clarify this behaviour so that if you know that you are going to need to cater to this kind of client, you'll know that this timeout might need to be higher

kevinmcconnell commented 2 months ago

Thanks @alexspeller! This looks great.