Code

Opened 7 years ago

Closed 6 years ago

#5480 closed (wontfix)

Mismatched numbering of model examples

Reported by: nickefford Owned by: stugots
Component: Documentation Version: master
Severity: Keywords:
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

The numbered list of model examples at http://www.djangoproject.com/documentation/models/ doesn't match the numbering used in the headings of the example pages. My suggested fix, for easy future maintenance, is to remove the numbers from the headings of each example page. If folk are happy with this, I'll work up a patch.

Attachments (2)

5480.diff (18.2 KB) - added by minarets 7 years ago.
Removed numbers from docstrings. Assuming this is the way to go.
5480.patch (15.6 KB) - added by stugots 6 years ago.
Renumbered the docstrings within each model file

Download all attachments as: .zip

Change History (15)

comment:1 Changed 7 years ago by nickefford

  • Needs documentation unset
  • Needs tests unset
  • Owner changed from nobody to nickefford
  • Patch needs improvement unset

comment:2 Changed 7 years ago by nickefford

Hmm. It seems that the model examples are elsewhere, not under docs.

comment:3 Changed 7 years ago by ubernostrum

  • Triage Stage changed from Unreviewed to Accepted

comment:4 Changed 7 years ago by nickefford

Still happy to patch the relevant pages, if someone can tell me how to get hold of the relevant reST source...

comment:5 Changed 7 years ago by minarets

  • Owner changed from nickefford to minarets

Changed 7 years ago by minarets

Removed numbers from docstrings. Assuming this is the way to go.

comment:6 Changed 6 years ago by stugots

  • Has patch set
  • Resolution set to fixed
  • Status changed from new to closed

While looking for a ticket to claim, I came upon this one. It looks like minarets supplied a fix, but forgot to check the "has patch" box...

comment:7 Changed 6 years ago by stugots

  • Resolution fixed deleted
  • Status changed from closed to reopened

comment:8 Changed 6 years ago by minarets

Actually the patch I submitted isn't the right way to fix this ticket...

comment:9 Changed 6 years ago by stugots

Are you still working on this ticket? If not, tell me what you think is the right way to fix it, assign it to me, and I'll come up with the patch.

comment:10 Changed 6 years ago by minarets

  • Owner changed from minarets to stugots
  • Patch needs improvement set
  • Status changed from reopened to new

The ticket can't be fixed by removing the numbers like I did - the numbers just need to be fixed.

comment:11 Changed 6 years ago by stugots

I use TortoiseSVN on a Windows box. For changes in a directory hierarchy, it creates ".patch" files, not ".diff" files.

So, if my attachment isn't usable (the "Contributing to Django" page says patches should be in the format returned by "svn diff"... I don't know if TortoiseSVN is doing that!), let me know and I'll find a Linux box on which to make the .diff file.

Anyway...I'm attaching a patch to fix the numbers.

Changed 6 years ago by stugots

Renumbered the docstrings within each model file

comment:12 Changed 6 years ago by stugots

  • Patch needs improvement unset

comment:13 Changed 6 years ago by mtredinnick

  • Resolution set to wontfix
  • Status changed from new to closed

We no longer have the auto-generated list with the current documentation system. If/when we bring back examples that are generated from the test suite (and we might choose an alternated approach), we can address this in the new system. Closing for now, though, with thanks to the people who worked on this; the problem fell behind us.

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.