Documentation fix in comments customization page
|Reported by:||thejaswi_puthraya||Owned by:||nobody|
|Severity:||Keywords:||comments, customization, documentation|
|Has patch:||yes||Needs documentation:||no|
|Needs tests:||no||Patch needs improvement:||no|
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.
Change History (8)
Changed 5 years ago by thejaswi_puthraya
comment:1 Changed 5 years ago by thejaswi_puthraya
- milestone changed from 1.1 to 1.1 beta
- Needs documentation unset
- Needs tests unset
- Patch needs improvement unset
comment:5 Changed 5 years ago by jacob
- Component changed from django.contrib.comments to Documentation