Code

Opened 6 years ago

Closed 3 years ago

Last modified 3 years ago

#9033 closed (fixed)

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

Reported by: julien Owned by: dwillis
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 dwillis 4 years ago.

Download all attachments as: .zip

Change History (7)

comment:1 Changed 5 years ago by jacob

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted

comment:2 Changed 4 years ago by dwillis

  • milestone set to 1.3
  • Owner changed from nobody to dwillis
  • Status changed from new to assigned
  • Version changed from 1.0 to SVN

Changed 4 years ago by dwillis

comment:3 Changed 4 years ago by dwillis

  • Has patch set

comment:4 Changed 3 years ago by timo

  • Resolution set to fixed
  • Status changed from assigned to closed

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

comment:5 Changed 3 years ago by timo

(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 3 years ago by jacob

  • milestone 1.3 deleted

Milestone 1.3 deleted

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.