Code

Opened 5 years ago

Closed 5 years ago

Last modified 3 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: UI/UX:

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 5 years ago.
comments framework documentation patch

Download all attachments as: .zip

Change History (5)

Changed 5 years ago by mapleoin

comments framework documentation patch

comment:1 Changed 5 years ago by jacob

  • milestone set to 1.1
  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted

comment:2 Changed 5 years ago by jacob

  • Owner changed from mapleoin to jacob
  • Status changed from new to assigned

comment:3 Changed 5 years ago by jacob

  • Resolution set to fixed
  • Status changed from assigned to 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/).

comment:4 Changed 3 years ago by jacob

  • milestone 1.1 deleted

Milestone 1.1 deleted

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.