#9563 closed (fixed)
displaying comments docs lack attributes description
| Reported by: | mapleoin | Owned by: | Jacob |
|---|---|---|---|
| Component: | Documentation | Version: | 1.0 |
| Severity: | Keywords: | comments | |
| Cc: | Triage Stage: | Accepted | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description
The comments framework docs seem a bit incomplete when talking about Displaying comments. They do not specify exactly what methods are available to use on the comments. I dug into contrib/comments/models.py and found what I was looking for. I didn't include everything (omitted: user, get_as_text, get_absolute_url, _get_url, _set_url, _get_email, _set_email, _get_name, _set_name, _get_userinfo). Included: user_name, user_email, user_url, comment, submit_date, ip_address, is_public, is_removed. I don't know if I should have gone into more detail.
This is my first bug/patch/contribution to Django. I'd like help to improve.
Attachments (1)
Change History (5)
by , 15 years ago
| Attachment: | comments.patch added |
|---|
comment:1 by , 15 years ago
| milestone: | → 1.1 |
|---|---|
| Triage Stage: | Unreviewed → Accepted |
comment:2 by , 15 years ago
| Owner: | changed from to |
|---|---|
| Status: | new → assigned |
comment:3 by , 15 years ago
| Resolution: | → fixed |
|---|---|
| Status: | assigned → closed |
This was fixed in the mega doc patch I checked in some time ago (http://docs.djangoproject.com/en/dev/ref/contrib/comments/models/).
comments framework documentation patch