[Django] #20920: Rationalise F() andf Q() documentation

21 views
Skip to first unread message

Django

unread,
Aug 14, 2013, 9:11:24 AM8/14/13
to django-...@googlegroups.com
#20920: Rationalise F() andf Q() documentation
--------------------------------------+--------------------
Reporter: EvilDMP | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 1.5
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 0 | UI/UX: 0
--------------------------------------+--------------------
https://groups.google.com/d/msg/django-developers/L2j4sYViy5A/JMruW8ObqGkJ

Summary:

Main documentation of ``F()`` is in
https://docs.djangoproject.com/en/dev/topics/db/queries.html#query-
expressions/, but belongs in a new reference section /ref/models/queries.

This should also be the location for reference material for ``Q()``.

Discussion of different usage-cases of these query-related classes can
remain where it is, in various different places, with links to and from
the reference material.

--
Ticket URL: <https://code.djangoproject.com/ticket/20920>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

Django

unread,
Aug 14, 2013, 9:12:35 AM8/14/13
to django-...@googlegroups.com
#20920: Rationalise F() andf Q() documentation
-------------------------------------+-------------------------------------
Reporter: EvilDMP | Owner: EvilDMP
Type: | Status: assigned
Cleanup/optimization | Version: 1.5
Component: Documentation | Resolution:
Severity: Normal | Triage Stage:
Keywords: | Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by EvilDMP):

* status: new => assigned
* needs_docs: => 0
* owner: nobody => EvilDMP
* needs_tests: => 0
* needs_better_patch: => 0


--
Ticket URL: <https://code.djangoproject.com/ticket/20920#comment:1>

Django

unread,
Aug 14, 2013, 9:21:14 AM8/14/13
to django-...@googlegroups.com
#20920: Rationalise F() andf Q() documentation
-------------------------------------+-------------------------------------
Reporter: EvilDMP | Owner: EvilDMP
Type: | Status: assigned
Cleanup/optimization | Version: 1.5
Component: Documentation | Resolution:
Severity: Normal | Triage Stage:
Keywords: | Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Description changed by timo:

Old description:

> https://groups.google.com/d/msg/django-


> developers/L2j4sYViy5A/JMruW8ObqGkJ
>
> Summary:
>
> Main documentation of ``F()`` is in
> https://docs.djangoproject.com/en/dev/topics/db/queries.html#query-
> expressions/, but belongs in a new reference section /ref/models/queries.
>
> This should also be the location for reference material for ``Q()``.
>
> Discussion of different usage-cases of these query-related classes can
> remain where it is, in various different places, with links to and from
> the reference material.

New description:

https://groups.google.com/d/msg/django-developers/L2j4sYViy5A/JMruW8ObqGkJ

Summary:

Main documentation of `F()` is in
https://docs.djangoproject.com/en/dev/topics/db/queries.html#query-
expressions/, but belongs in a new reference section /ref/models/queries.

This should also be the location for reference material for `Q()`.

Discussion of different usage-cases of these query-related classes can
remain where it is, in various different places, with links to and from
the reference material.

--

--
Ticket URL: <https://code.djangoproject.com/ticket/20920#comment:2>

Django

unread,
Aug 14, 2013, 10:26:53 AM8/14/13
to django-...@googlegroups.com
#20920: Create a reference doc for F() and Q()
--------------------------------------+------------------------------------
Reporter: EvilDMP | Owner: EvilDMP
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: 1.5
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
--------------------------------------+------------------------------------
Changes (by timo):

* stage: Unreviewed => Accepted


--
Ticket URL: <https://code.djangoproject.com/ticket/20920#comment:3>

Django

unread,
Aug 14, 2013, 8:22:00 PM8/14/13
to django-...@googlegroups.com
#20920: Create a reference doc for F() and Q()
--------------------------------------+------------------------------------
Reporter: EvilDMP | Owner: EvilDMP
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: 1.5

Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
--------------------------------------+------------------------------------

Comment (by EvilDMP):

Started work on this: https://github.com/django/django/pull/1476 -
comments and corrections please

--
Ticket URL: <https://code.djangoproject.com/ticket/20920#comment:4>

Django

unread,
Aug 30, 2013, 7:16:25 AM8/30/13
to django-...@googlegroups.com
#20920: Create a reference doc for F() and Q()
--------------------------------------+------------------------------------
Reporter: EvilDMP | Owner: EvilDMP
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: master

Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
--------------------------------------+------------------------------------
Changes (by timo):

* has_patch: 0 => 1
* version: 1.5 => master


--
Ticket URL: <https://code.djangoproject.com/ticket/20920#comment:5>

Django

unread,
Sep 6, 2013, 8:00:03 AM9/6/13
to django-...@googlegroups.com
#20920: Create a reference doc for F() and Q()
-------------------------------------+-------------------------------------
Reporter: EvilDMP | Owner: EvilDMP
Type: | Status: assigned
Cleanup/optimization | Version: master
Component: Documentation | Resolution:
Severity: Normal | Triage Stage: Ready for
Keywords: | checkin

Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by timo):

* stage: Accepted => Ready for checkin


Comment:

Left a couple minor comments. Feel free to commit after making the
suggested changes.

--
Ticket URL: <https://code.djangoproject.com/ticket/20920#comment:6>

Django

unread,
Sep 6, 2013, 2:28:05 PM9/6/13
to django-...@googlegroups.com
#20920: Create a reference doc for F() and Q()
-------------------------------------+-------------------------------------
Reporter: EvilDMP | Owner: EvilDMP
Type: | Status: closed
Cleanup/optimization | Version: master
Component: Documentation | Resolution: fixed

Severity: Normal | Triage Stage: Ready for
Keywords: | checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Daniele Procida <daniele@…>):

* status: assigned => closed
* resolution: => fixed


Comment:

In [changeset:"263eecc583223652dd24f9189144b39d5dd5b62d"]:
{{{
#!CommitTicketReference repository=""
revision="263eecc583223652dd24f9189144b39d5dd5b62d"
Merge pull request #1544 from evildmp/ticket_20920_rebase

Fixed #20920 -- Consolidated F() and Q() documentation
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/20920#comment:7>

Reply all
Reply to author
Forward
0 new messages