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
So I have added a patch to clarify in the documentation.