Opened 8 years ago

Closed 7 years ago

Last modified 7 years ago

#9819 closed (fixed)

Comments Framework needs better documentation

Reported by: Kegan Gan Owned by: nobody
Component: contrib.comments Version: master
Severity: Keywords:
Cc: hanne.moa@… Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

Comments Framework needs better documentation.

A lot of the features in the code that are not reflected in the documentation. This ticket should provide documentation for:

  • settings.py configuration
  • deletion
  • flagging
  • moderation/approval
  • feeds
  • customizing forms
  • using comments
  • using views
  • comment custom manager

Attachments (2)

comment-settings.diff (853 bytes) - added by Kegan Gan 8 years ago.
Tiny patch for comments settings
9819.diff (7.5 KB) - added by Thejaswi Puthraya 7 years ago.
git-patch against the latest checkout

Download all attachments as: .zip

Change History (10)

Changed 8 years ago by Kegan Gan

Attachment: comment-settings.diff added

Tiny patch for comments settings

comment:1 Changed 8 years ago by Kegan Gan

Needs documentation: unset
Needs tests: unset
Patch needs improvement: unset

More patches to come.

comment:2 Changed 8 years ago by Jacob

Triage Stage: UnreviewedAccepted

comment:3 Changed 7 years ago by martin.hviid.andersen@…

It doesn't either state in the documentation, that it depends on 'django.contrib.sites', which I think is rather important for new users of Django.

comment:4 Changed 7 years ago by HM

Cc: hanne.moa@… added

We could use this ticket to collect other tickets about missing docs for comments, here's my current pet peeve: #11870

comment:5 Changed 7 years ago by Thejaswi Puthraya

See also #9604 which is a subset of this ticket.

Changed 7 years ago by Thejaswi Puthraya

Attachment: 9819.diff added

git-patch against the latest checkout

comment:6 Changed 7 years ago by Thejaswi Puthraya

Has patch: set

The patch covers usage of comments and through this highlights certain
undocumented functionality. It intentionally leaves out certain features
like profanity filtering, group moderation because these are scheduled
to be removed in future versions.

comment:7 Changed 7 years ago by Jannis Leidel

Resolution: fixed
Status: newclosed

(In [12079]) Fixed #9819 - Added exemplary documentation for comments app. Thanks for the initial patch, Thejaswi Puthraya.

comment:8 Changed 7 years ago by Jannis Leidel

(In [12245]) [1.1.X] Fixed #9819 - Added exemplary documentation for comments app. Thanks for the initial patch, Thejaswi Puthraya.

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