Opened 3 years ago

Closed 3 years ago

#20920 closed Cleanup/optimization (fixed)

Create a reference doc for F() and Q()

Reported by: Daniele Procida Owned by: Daniele Procida
Component: Documentation Version: master
Severity: Normal Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description (last modified by Tim Graham)

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.

Change History (7)

comment:1 Changed 3 years ago by Daniele Procida

Owner: changed from nobody to Daniele Procida
Status: newassigned

comment:2 Changed 3 years ago by Tim Graham

Description: modified (diff)

comment:3 Changed 3 years ago by Tim Graham

Summary: Rationalise F() andf Q() documentationCreate a reference doc for F() and Q()
Triage Stage: UnreviewedAccepted

comment:4 Changed 3 years ago by Daniele Procida

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

comment:5 Changed 3 years ago by Tim Graham

Has patch: set
Version: 1.5master

comment:6 Changed 3 years ago by Tim Graham

Triage Stage: AcceptedReady for checkin

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

comment:7 Changed 3 years ago by Daniele Procida <daniele@…>

Resolution: fixed
Status: assignedclosed

In 263eecc583223652dd24f9189144b39d5dd5b62d:

Merge pull request #1544 from evildmp/ticket_20920_rebase

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

Note: See TracTickets for help on using tickets.
Back to Top