#27587: str(QuerySet.query) should be documented
------------------------------------------+------------------------
Reporter: Peter Inglesby | Owner: nobody
Type: Uncategorized | Status: new
Component: Documentation | Version: 1.10
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 1
UI/UX: 0 |
------------------------------------------+------------------------
As far as I can tell, the only place where the behaviour of
`str(QuerySet.query)` is mentioned in the docs is as a throwaway comment
in [https://docs.djangoproject.com/en/1.10/topics/db/aggregation/ the
aggregation topic], and in a code example in
[https://docs.djangoproject.com/en/1.10/ref/contrib/gis/tutorial/ the
GeoDjango tutorial].
This is very useful behaviour but it is not widely known. Additionally,
its limitations (see ticket:12611, "Incorrect quoting in
QuerySet.query.__str__()") are even less widely known.
I think it would be suitable to add this to
[https://docs.djangoproject.com/en/1.10/intro/tutorial02/ section 2 of the
tutorial], and to the
[https://docs.djangoproject.com/en/1.10/topics/db/queries/ Making queries
topic guide].
--
Ticket URL: <https://code.djangoproject.com/ticket/27587>
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 post to this group, send email to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/050.1da7f34619b88b0699f18d568d72981b%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
