Opened 14 years ago

Closed 14 years ago

Last modified 12 years ago

#12997 closed (fixed)

Add Metadata Targets to QuerySet API Reference

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

Description

I've switched titles to targets in the QuerySet API reference, per http://docs.djangoproject.com/en/dev/internals/documentation/#todo

Attachments (3)

12997.patch (8.0 KB ) - added by Derek Willis 14 years ago.
12997-r12842.diff (5.9 KB ) - added by Ramiro Morales 14 years ago.
Patch updated wiht some missed methods, updated to r12842 and modified to no remove the title markup.
12997-1.1.X-r13132.diff (5.7 KB ) - added by Ramiro Morales 14 years ago.
Patch for 1.1.X branch updated to apply cleanly as of now

Download all attachments as: .zip

Change History (13)

by Derek Willis, 14 years ago

Attachment: 12997.patch added

comment:1 by Derek Willis, 14 years ago

Component: UncategorizedDocumentation
Status: newassigned

comment:2 by Russell Keith-Magee, 14 years ago

Triage Stage: UnreviewedAccepted

by Ramiro Morales, 14 years ago

Attachment: 12997-r12842.diff added

Patch updated wiht some missed methods, updated to r12842 and modified to no remove the title markup.

comment:3 by Ramiro Morales, 14 years ago

milestone: 1.3

Problem is that if we remove the titles, the methods don't appear in the local HTML TOC (shown in the left sidebar) and so we loose the useful ability of easily jumping to an arbitrary method section.

I modified the patch to have both the title and new crossref metatdata markup, this makes the method headers look a bit ugly (content generated by the new crossref metatdata markup appear below the titles and is identical) but oh well, it seems we have two requirements (easy navigation, desirability of more metadata markup) whose current results when pursued together aren't ideal in this case.

Removing milestone = 1.3. Justin committed some related changes in r12808 so IMHO there is hope we can get this in 1.2.

by Ramiro Morales, 14 years ago

Attachment: 12997-1.1.X-r13132.diff added

Patch for 1.1.X branch updated to apply cleanly as of now

comment:4 by Ramiro Morales, 14 years ago

milestone: 1.2
Triage Stage: AcceptedReady for checkin

comment:5 by Russell Keith-Magee, 14 years ago

Resolution: fixed
Status: assignedclosed

(In [13162]) Fixed #12997 -- Added markup for methods in the queryset docs. Thanks to Ramiro Morales for the patch.

comment:6 by Russell Keith-Magee, 14 years ago

(In [13165]) [1.1.X] Fixed #12997 -- Added markup for methods in the queryset docs. Thanks to Ramiro Morales for the patch.

Backport of r13162 from trunk.

comment:7 by Tim Graham, 14 years ago

Patch needs improvement: set
Resolution: fixed
Status: closedreopened
Triage Stage: Ready for checkinAccepted

Looks like these methods are appearing in the django.db.models namespace rather than django.db.models.QuerySet. We need another currentmodule declaration (django.db.models.QuerySet) or else each target needs "QuerySet." prefix:

.. method:: QuerySet.filter(**kwargs) 

The patch in #11800 does the latter. With the current setup, a link would look like "django.db.models.defer" whereas I think they should look like "django.db.models.QuerySet.defer".

comment:8 by Russell Keith-Magee, 14 years ago

Resolution: fixed
Status: reopenedclosed

(In [13235]) Fixed #12997 -- Corrected the module markup for QuerySet? methods. Thanks to timo for the report.

comment:9 by Russell Keith-Magee, 14 years ago

(In [13236]) [1.1.X] Fixed #12997 -- Corrected the module markup for QuerySet methods. Thanks to timo for the report.

Backport of r13235 from trunk.

comment:10 by Jacob, 12 years ago

milestone: 1.2

Milestone 1.2 deleted

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