#25444: Restructure expressions documentation to better highlight ORM support
-----------------------------------------+------------------------
Reporter: jarshwah | Owner: nobody
Type: Uncategorized | Status: new
Component: Uncategorized | Version: master
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 1 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-----------------------------------------+------------------------
The docs in docs/ref/models/expressions.txt could probably do with an
overhaul. The original document was very specific about highlighting the
use-cases of F expressions in terms of filter and update.
I think the docs should be structured in terms of which queryset methods
support expressions. We can then leave the specific expression reference
below.
Some of the F() examples can be pulled out into the queryset method
sections, but the F() section can still highlight the things it is
particularly good at -- like avoiding race conditions.
The docs would be structured like:
{{{
=================
Query Expressions
=================
Intro..
Supported QuerySet Operations
=========================
Not every :doc:`QuerySet </ref/models/queryset>` method has full support
for
Query Expressions, but the support is growing with each release. Below is
a
quick overview showing which methods do have support.
create() and update()
----------------------------------
Intro
Examples
filter() and exclude()
--------------------------------
Intro
Examples
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/25444>
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/051.36907f7d865eab92e00422a1236b4e7a%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
