Code

Opened 4 years ago

Closed 4 years ago

Last modified 3 years ago

#12997 closed (fixed)

Add Metadata Targets to QuerySet API Reference

Reported by: dwillis 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: yes
Easy pickings: UI/UX:

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 dwillis 4 years ago.
12997-r12842.diff (5.9 KB) - added by ramiro 4 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 4 years ago.
Patch for 1.1.X branch updated to apply cleanly as of now

Download all attachments as: .zip

Change History (13)

Changed 4 years ago by dwillis

comment:1 Changed 4 years ago by dwillis

  • Component changed from Uncategorized to Documentation
  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Status changed from new to assigned

comment:2 Changed 4 years ago by russellm

  • Triage Stage changed from Unreviewed to Accepted

Changed 4 years ago by ramiro

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

comment:3 Changed 4 years ago by ramiro

  • milestone 1.3 deleted

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.

Changed 4 years ago by ramiro

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

comment:4 Changed 4 years ago by ramiro

  • milestone set to 1.2
  • Triage Stage changed from Accepted to Ready for checkin

comment:5 Changed 4 years ago by russellm

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

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

comment:6 Changed 4 years ago by russellm

(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 Changed 4 years ago by timo

  • Patch needs improvement set
  • Resolution fixed deleted
  • Status changed from closed to reopened
  • Triage Stage changed from Ready for checkin to 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 Changed 4 years ago by russellm

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

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

comment:9 Changed 4 years ago by russellm

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

  • milestone 1.2 deleted

Milestone 1.2 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.