#34556: StreamingHttpResponse documentation inaccuracy
--------------------------------------------+------------------------
Reporter: Alexandre Spaeth | Owner: nobody
Type: Uncategorized | Status: new
Component: Documentation | Version: 4.2
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
--------------------------------------------+------------------------
While working on adding typing in django-stubs for the async version of
StreamingHttpResponse, we noticed that the documentation for
`StreamingHttpResponse` mentions
> It should be given an iterator that yields bytestrings as content.
But reading at the code (and the tests), it’s clear that the content can
actually also be a string (or anything that can be converted to
bytestrings by `make_bytes`). If that’s the expected behaviour (and I’m
assuming it is, looking at the `content` documentation for
`HttpResponse`), I suggest we fix the documentation.
--
Ticket URL: <https://code.djangoproject.com/ticket/34556>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/01070188067e4286-e70da8a5-336c-4002-9498-6576eb2963ff-000000%40eu-central-1.amazonses.com.
