Opened 16 years ago

Closed 16 years ago

Last modified 13 years ago

#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)

comments.patch (1.1 KB ) - added by mapleoin 16 years ago.
comments framework documentation patch

Download all attachments as: .zip

Change History (5)

by mapleoin, 16 years ago

Attachment: comments.patch added

comments framework documentation patch

comment:1 by Jacob, 16 years ago

milestone: 1.1
Triage Stage: UnreviewedAccepted

comment:2 by Jacob, 16 years ago

Owner: changed from mapleoin to Jacob
Status: newassigned

comment:3 by Jacob, 16 years ago

Resolution: fixed
Status: assignedclosed

This was fixed in the mega doc patch I checked in some time ago (http://docs.djangoproject.com/en/dev/ref/contrib/comments/models/).

comment:4 by Jacob, 13 years ago

milestone: 1.1

Milestone 1.1 deleted

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