Opened 14 years ago

Closed 14 years ago

Last modified 14 years ago

#16021 closed Bug (fixed)

Minor documentation fixes for Generic Class Views

Reported by: Bradley Ayers <bradley.ayers@…> Owned by: nobody
Component: Documentation Version: 1.3
Severity: Normal Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

I noticed some minor styling problems, and one explicit error in the documentation for Generic Class Views.

Attachments (5)

generic-views-docs.patch (4.0 KB ) - added by Bradley Ayers <bradley.ayers@…> 14 years ago.
generic-views-docs-2.patch (4.3 KB ) - added by Bradley Ayers <bradley.ayers@…> 14 years ago.
generic-views-docs-3.patch (4.3 KB ) - added by Bradley Ayers <bradley.ayers@…> 14 years ago.
generic-views-docs-4.patch (4.8 KB ) - added by Bradley Ayers <bradley.ayers@…> 14 years ago.
16021.generic-views-docs.diff (5.1 KB ) - added by Julien Phalip 14 years ago.

Download all attachments as: .zip

Change History (11)

by Bradley Ayers <bradley.ayers@…>, 14 years ago

Attachment: generic-views-docs.patch added

comment:1 by Julien Phalip, 14 years ago

Triage Stage: UnreviewedAccepted

Thank you for this. The patch looks mostly fine. Just a couple of points: the word "model" should not be capitalised; also there are no reasons why the Meta class should be moved above the __unicode__ method.

comment:2 by bradley.ayers@…, 14 years ago

Thanks I'll fix up the patch with regard to the model capitalization. The reason why I swapped the order of the Meta and unicode method is due to Django's style guide http://docs.djangoproject.com/en/1.3/internals/contributing/#model-style. There's a list of of the order that the methods should be defined in around the third bullet point in that section.

by Bradley Ayers <bradley.ayers@…>, 14 years ago

Attachment: generic-views-docs-2.patch added

by Bradley Ayers <bradley.ayers@…>, 14 years ago

Attachment: generic-views-docs-3.patch added

by Bradley Ayers <bradley.ayers@…>, 14 years ago

Attachment: generic-views-docs-4.patch added

by Julien Phalip, 14 years ago

comment:3 by Julien Phalip, 14 years ago

Triage Stage: AcceptedReady for checkin

Thanks a lot. The patch looks good. I've just capitalized the word "Model" ;-)

comment:4 by Tim Graham, 14 years ago

Resolution: fixed
Status: newclosed

In [16256]:

Fixed #16021 - Minor documentation fixes for Generic Class Views; thanks Bradley Ayers.

comment:5 by Tim Graham, 14 years ago

In [16257]:

[1.3.X] Fixed #16021 - Minor documentation fixes for Generic Class Views; thanks Bradley Ayers.

Backport of r16256 from trunk.

comment:6 by Julien Phalip, 14 years ago

Whoops, sorry for the confusion. As I said originally, "model" should indeed *not* be capitalized.

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