Opened 8 years ago

Closed 6 years ago

Last modified 5 years ago

#8975 closed (fixed)

related order functions are not documented

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

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 6 years ago.

Download all attachments as: .zip

Change History (12)

comment:1 Changed 8 years ago by Malcolm Tredinnick

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 Changed 8 years ago by Jacob

Triage Stage: UnreviewedAccepted

comment:3 Changed 8 years ago by James Wheare

Cc: James Wheare added

comment:4 Changed 7 years ago by anonymous

Cc: bas@… added

comment:5 Changed 7 years ago by Leo Shklovskii

milestone: 1.3

Adding to milestone for consideration.

comment:6 Changed 6 years ago by anonymous

[]

comment:7 Changed 6 years ago by Derek Willis

Owner: changed from nobody to Derek Willis
Status: newassigned

Changed 6 years ago by Derek Willis

Attachment: 8975.diff added

comment:8 Changed 6 years ago by Derek Willis

Has patch: set

comment:9 Changed 6 years ago by Simon Meers

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 Changed 6 years ago by Simon Meers

(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 Changed 5 years ago by Jacob

milestone: 1.3

Milestone 1.3 deleted

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