Opened 16 years ago

Closed 16 years ago

Last modified 13 years ago

#10559 closed (fixed)

Documentation fix in comments customization page

Reported by: Thejaswi Puthraya Owned by: nobody
Component: Documentation Version: dev
Severity: Keywords: comments, customization, documentation
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

The current documentation mentions that all the custom comment models must subclass from the BaseCommentAbstractModel which is not totally right.
In the example in the documentation, it adds a title field to the model after subclassing from BaseCommentAbstractModel but the form subclassed from CommentForm displays the Name, Email, URL etc. So these extra form fields like Name, Email etc are not saved into the db and is an easy way of confusing people.

Ideally, most cases would require to just subclass from the Comment model. Only in special cases, there will be a requirement to subclass from the BaseCommentAbstractModel.

So I have added a patch to clarify in the documentation.

Attachments (1)

10559.diff (1.5 KB ) - added by Thejaswi Puthraya 16 years ago.
git-patch against the latest checkout

Download all attachments as: .zip

Change History (8)

by Thejaswi Puthraya, 16 years ago

Attachment: 10559.diff added

git-patch against the latest checkout

comment:1 by Thejaswi Puthraya, 16 years ago

milestone: 1.11.1 beta

comment:2 by Malcolm Tredinnick, 16 years ago

milestone: 1.1 beta1.1

Documentation fixes aren't feature additions. Slow down a bit with moving things to 1.1 beta. This is a normal bug that will be fixed in the normal flow of things.

in reply to:  2 comment:3 by Thejaswi Puthraya, 16 years ago

Replying to mtredinnick:

Documentation fixes aren't feature additions. Slow down a bit with moving things to 1.1 beta. This is a normal bug that will be fixed in the normal flow of things.

Sorry about mis-labeling and thanks for pointing out the difference between the 1.1 and 1.1beta tag.

comment:4 by Jacob, 16 years ago

Triage Stage: UnreviewedAccepted

comment:5 by Jacob, 16 years ago

Component: django.contrib.commentsDocumentation

comment:6 by Russell Keith-Magee, 16 years ago

Resolution: fixed
Status: newclosed

(In [10566]) Fixed #10559 -- Clarified documentation on customization of comments pages. Thanks to Thejaswi Puthraya for the patch.

comment:7 by Jacob, 13 years ago

milestone: 1.1

Milestone 1.1 deleted

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