Opened 16 years ago

Closed 13 years ago

Last modified 12 years ago

#8975 closed (fixed)

related order functions are not documented

Reported by: Leo Shklovskii Owned by: Derek Willis
Component: Documentation Version: dev
Severity: Keywords:
Cc: James Wheare, bas@… Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

The functions detailed in this blog post:
http://james.wheare.org/notes/2007/11/ordering-related-objects-in-django.php

aren't documented at all in the main Django documentation, for example:
http://docs.djangoproject.com/en/dev/search/?cx=009763561546736975936%3Ae88ek0eurf4&cof=FORID%3A11&ie=UTF-8&hl=&q=get_previous_in_order&sa=Search&as_q=more%3Adev_docs#242

These are super useful functions and it would be great to have them be described in the docs.

If they're meant to be private then should they be renamed to begin with an '_'?

Attachments (1)

8975.diff (1.7 KB ) - added by Derek Willis 14 years ago.

Download all attachments as: .zip

Change History (12)

comment:1 by Malcolm Tredinnick, 15 years ago

Just a note in case anybody wonders: the commit message for r9167 says it fixed this ticket. That was a typo in the commit message. It should have referred to #8184. This isn't fixed yet.

comment:2 by Jacob, 15 years ago

Triage Stage: UnreviewedAccepted

comment:3 by James Wheare, 15 years ago

Cc: James Wheare added

comment:4 by anonymous, 14 years ago

Cc: bas@… added

comment:5 by Leo Shklovskii, 14 years ago

milestone: 1.3

Adding to milestone for consideration.

comment:6 by anonymous, 14 years ago

[]

comment:7 by Derek Willis, 14 years ago

Owner: changed from nobody to Derek Willis
Status: newassigned

by Derek Willis, 14 years ago

Attachment: 8975.diff added

comment:8 by Derek Willis, 14 years ago

Has patch: set

comment:9 by Simon Meers, 13 years ago

Resolution: fixed
Status: assignedclosed

(In [14848]) Fixed #8975 -- documented related order methods -- thanks to Leo for the report and dwillis for the initial patch.

comment:10 by Simon Meers, 13 years ago

(In [14849]) [1.2.X] Fixed #8975 -- documented related order methods -- thanks to Leo for the report and dwillis for the initial patch.

Backport of r14848 from trunk.

comment:11 by Jacob, 12 years ago

milestone: 1.3

Milestone 1.3 deleted

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