#9819 closed (fixed)
Comments Framework needs better documentation
| Reported by: | Kegan Gan | Owned by: | nobody |
|---|---|---|---|
| Component: | contrib.comments | Version: | dev |
| Severity: | Keywords: | ||
| Cc: | hanne.moa@… | Triage Stage: | Accepted |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
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)
Change History (10)
Changed 15 years ago by
| Attachment: | comment-settings.diff added |
|---|
comment:2 Changed 15 years ago by
| Triage Stage: | Unreviewed → Accepted |
|---|
comment:3 Changed 15 years ago by
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 14 years ago by
| 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:6 Changed 14 years ago by
| 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 14 years ago by
| Resolution: | → fixed |
|---|---|
| Status: | new → closed |
comment:8 Changed 14 years ago by
Note: See
TracTickets for help on using
tickets.
Tiny patch for comments settings