#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)
Change History (13)
by , 15 years ago
Attachment: | 12997.patch added |
---|
comment:1 by , 15 years ago
Component: | Uncategorized → Documentation |
---|---|
Status: | new → assigned |
comment:2 by , 15 years ago
Triage Stage: | Unreviewed → Accepted |
---|
by , 15 years ago
Attachment: | 12997-r12842.diff added |
---|
comment:3 by , 15 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 , 15 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 , 15 years ago
milestone: | → 1.2 |
---|---|
Triage Stage: | Accepted → Ready for checkin |
comment:5 by , 15 years ago
Resolution: | → fixed |
---|---|
Status: | assigned → closed |
comment:6 by , 15 years ago
comment:7 by , 15 years ago
Patch needs improvement: | set |
---|---|
Resolution: | fixed |
Status: | closed → reopened |
Triage Stage: | Ready for checkin → Accepted |
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 , 14 years ago
Resolution: | → fixed |
---|---|
Status: | reopened → closed |
Patch updated wiht some missed methods, updated to r12842 and modified to no remove the title markup.