Opened 9 years ago

Closed 8 years ago

#5480 closed (wontfix)

Mismatched numbering of model examples

Reported by: Nick Efford Owned by: John DeRosa
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 Maura Chace 9 years ago.
Removed numbers from docstrings. Assuming this is the way to go.
5480.patch (15.6 KB) - added by John DeRosa 9 years ago.
Renumbered the docstrings within each model file

Download all attachments as: .zip

Change History (15)

comment:1 Changed 9 years ago by Nick Efford

Owner: changed from nobody to Nick Efford

comment:2 Changed 9 years ago by Nick Efford

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

comment:3 Changed 9 years ago by James Bennett

Triage Stage: UnreviewedAccepted

comment:4 Changed 9 years ago by Nick Efford

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

comment:5 Changed 9 years ago by Maura Chace

Owner: changed from Nick Efford to Maura Chace

Changed 9 years ago by Maura Chace

Attachment: 5480.diff added

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

comment:6 Changed 9 years ago by John DeRosa

Has patch: set
Resolution: fixed
Status: newclosed

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 9 years ago by John DeRosa

Resolution: fixed
Status: closedreopened

comment:8 Changed 9 years ago by Maura Chace

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

comment:9 Changed 9 years ago by John DeRosa

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 9 years ago by Maura Chace

Owner: changed from Maura Chace to John DeRosa
Patch needs improvement: set
Status: reopenednew

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

comment:11 Changed 9 years ago by John DeRosa

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 9 years ago by John DeRosa

Attachment: 5480.patch added

Renumbered the docstrings within each model file

comment:12 Changed 9 years ago by John DeRosa

Patch needs improvement: unset

comment:13 Changed 8 years ago by Malcolm Tredinnick

Resolution: wontfix
Status: newclosed

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.

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