net/http: clarify that TimeoutHandler buffers all writes into memory #47899
Labels
Documentation
Issues describing a change to documentation.
NeedsInvestigation
Someone must examine and confirm this is a valid issue and not a duplicate of an existing one.
Milestone
While reading
http.TimeoutHandler
implementation I noticed that in current docs there's no mention that all writes in the response are buffered in memory before being flushed to the client.Digging a bit in the git history, this was a clarification that was present on the original implementation.
The last change that touched the docs has a good summary of some back and forth in implementing
Flusher
, which docs changes made this original note be lost.It feels to me that clarifying that all writes are buffered to memory is something worth adding again since that should be considered by users when wrapping handlers that might produce big writes.
The proposed new docs for that paragraph could be:
If that sounds like a good idea, I can create a CL with this change.
The text was updated successfully, but these errors were encountered: