Opened 8 years ago

Closed 6 years ago

Last modified 5 years ago

#9033 closed (fixed)

QuerySet extra()'s arguments could be better represented visually in the doc

Reported by: Julien Phalip Owned by: Derek Willis
Component: Documentation Version: master
Severity: Keywords:
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

Currently in the Queryset API documentation (1), the arguments for extra() (e.g. select, params, order_by...), although correctly defined, don't clearly show as sub-parts in the section. Visually they seem to be at the same level as the other queryset methods.

To fix this, one could use bullets, like it's been done for the fieldsets dictionary keys ("fields", "classes" and "description") in the admin doc (2).

Not a big deal but that'd be a nice improvement.

(1) http://docs.djangoproject.com/en/dev/ref/models/querysets/#extra-select-none-where-none-params-none-tables-none-order-by-none-select-params-none

(2) http://docs.djangoproject.com/en/dev/ref/contrib/admin/#fieldsets

Attachments (1)

9033.diff (13.7 KB) - added by Derek Willis 6 years ago.

Download all attachments as: .zip

Change History (7)

comment:1 Changed 8 years ago by Jacob

Triage Stage: UnreviewedAccepted

comment:2 Changed 6 years ago by Derek Willis

milestone: 1.3
Owner: changed from nobody to Derek Willis
Status: newassigned
Version: 1.0SVN

Changed 6 years ago by Derek Willis

Attachment: 9033.diff added

comment:3 Changed 6 years ago by Derek Willis

Has patch: set

comment:4 Changed 6 years ago by Tim Graham

Resolution: fixed
Status: assignedclosed

(In [14816]) Fixed #9033 - Add bullets to QuerySet extra() arguments. thanks julien for the suggestion and dwillis for the patch.

comment:5 Changed 6 years ago by Tim Graham

(In [14817]) [1.2.X] Fixed #9033 - Add bullets to QuerySet extra() arguments. thanks julien for the suggestion and dwillis for the patch.

Backport of r14816 from trunk.

comment:6 Changed 5 years ago by Jacob

milestone: 1.3

Milestone 1.3 deleted

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