#23878: Query object/expression documentation needs to tidied
--------------------------------------+--------------------
     Reporter:  EvilDMP               |      Owner:  nobody
         Type:  Cleanup/optimization  |     Status:  new
    Component:  Documentation         |    Version:  master
     Severity:  Normal                |   Keywords:
 Triage Stage:  Unreviewed            |  Has patch:  0
Easy pickings:  1                     |      UI/UX:  0
--------------------------------------+--------------------
 docs/ref/models/queries.txt **Query-related classes** was created for new
 `F()` documentation, and then the notes on `Q()` were added, followed
 later by `Prefetch()`.

 As that document noted, "This document provides reference material for
 query-related tools not documented elsewhere" - in other words, things
 that we couldn't find a good place for elsewhere.

 Now `F()` has moved out, into the new docs/ref/models/expressions.txt
 **Query Expressions** document, and **Query-related classes** now looks
 even less satisfactory than before.

 I propose:

 * moving the note on `Q()` into docs/ref/models/expressions.txt
 * moving `Prefetch()` into
 https://docs.djangoproject.com/en/dev/ref/models/querysets/#prefetch-
 related, or perhaps elsewhere on that page
 * moving the https://docs.djangoproject.com/en/dev/ref/models/querysets
 /#aggregation-functions documentation into docs/ref/models/expressions.txt
 * and of course, removing docs/ref/models/queries.txt altogether

--
Ticket URL: <https://code.djangoproject.com/ticket/23878>
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.7d460984d7ef56f727bd0dba08aa588f%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.

Reply via email to