Opened 6 years ago

Closed 6 years ago

Last modified 4 years ago

#10559 closed (fixed)

Documentation fix in comments customization page

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

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 6 years ago.
git-patch against the latest checkout

Download all attachments as: .zip

Change History (8)

Changed 6 years ago by thejaswi_puthraya

git-patch against the latest checkout

comment:1 Changed 6 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:2 follow-up: Changed 6 years ago by mtredinnick

  • milestone changed from 1.1 beta to 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 in reply to: ↑ 2 Changed 6 years ago by thejaswi_puthraya

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 Changed 6 years ago by jacob

  • Triage Stage changed from Unreviewed to Accepted

comment:5 Changed 6 years ago by jacob

  • Component changed from django.contrib.comments to Documentation

comment:6 Changed 6 years ago by russellm

  • Resolution set to fixed
  • Status changed from new to closed

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

comment:7 Changed 4 years ago by jacob

  • milestone 1.1 deleted

Milestone 1.1 deleted

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