Code

Opened 6 years ago

Closed 3 years ago

Last modified 3 years ago

#8975 closed (fixed)

related order functions are not documented

Reported by: Leo Owned by: dwillis
Component: Documentation Version: master
Severity: Keywords:
Cc: jwheare, 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 dwillis 4 years ago.

Download all attachments as: .zip

Change History (12)

comment:1 Changed 6 years ago by mtredinnick

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset

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 5 years ago by jacob

  • Triage Stage changed from Unreviewed to Accepted

comment:3 Changed 5 years ago by jwheare

  • Cc jwheare added

comment:4 Changed 4 years ago by anonymous

  • Cc bas@… added

comment:5 Changed 4 years ago by Leo

  • milestone set to 1.3

Adding to milestone for consideration.

comment:6 Changed 4 years ago by anonymous

[]

comment:7 Changed 4 years ago by dwillis

  • Owner changed from nobody to dwillis
  • Status changed from new to assigned

Changed 4 years ago by dwillis

comment:8 Changed 4 years ago by dwillis

  • Has patch set

comment:9 Changed 3 years ago by DrMeers

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

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

comment:10 Changed 3 years ago by DrMeers

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

  • milestone 1.3 deleted

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