#23878: Query object/expression documentation needs to tidied
--------------------------------------+------------------------------------
Reporter: EvilDMP | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
--------------------------------------+------------------------------------
Comment (by jarshwah):
Agreed that the query expression API should be moved to expressions.txt.
Yeah lookups are not really an appropriate place either - I was thinking
about the relationship between lookups and filters. But the problem with
including Q in the expressions document, is that the expressions document
really focuses on composability and a strict API, neither of which Q()
implements.
If Prefetch was to be moved to the querysets document, perhaps at the
bottom with a link as suggested by @carljm, I would think the same could
be done with Q() with a link from filter and exclude. The documentation
for these 2 classes are sparse, and shouldn't complicate the rest of the
documentation too much.
--
Ticket URL: <https://code.djangoproject.com/ticket/23878#comment:4>
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/065.b1d40144eed2a83a278a682ce36c6a80%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
