docs: update body_snapshot docstring for clarity#73
Open
Benflow3 wants to merge 2 commits into
Open
Conversation
Clarify behavior of body_snapshot method for LoggableResponseBody.
| Safe to call from logging and post-mortem paths: it never drains a | ||
| single-use stream. Bytes are only returned when the body has already | ||
| been captured for repeatable reads (a ``LoggableResponseBody``); for | ||
| For a LoggableResponseBody, the snapshot drains and caches the inner |
Member
There was a problem hiding this comment.
Verified this against the code and it's accurate — it does drain and cache the inner body on the first read. Only nit: wrap LoggableResponseBody in double backticks to match the rest of the docstring, then it's good to merge.
Wrap LoggableResponseBody in double backticks
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
2 participants
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