#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)
Change History (8)
by , 16 years ago
Attachment: | 10559.diff added |
---|
comment:1 by , 16 years ago
milestone: | 1.1 → 1.1 beta |
---|
follow-up: 3 comment:2 by , 16 years ago
milestone: | 1.1 beta → 1.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.
comment:3 by , 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 , 16 years ago
Triage Stage: | Unreviewed → Accepted |
---|
comment:5 by , 16 years ago
Component: | django.contrib.comments → Documentation |
---|
comment:6 by , 16 years ago
Resolution: | → fixed |
---|---|
Status: | new → closed |
git-patch against the latest checkout