Django

Code

Ticket #1853 (assigned)

Opened 2 years ago

Last modified 1 year ago

admin documentation section errors for 'comments' tags

Reported by: jmoiron@jmoiron.net Assigned to: nobody (accepted)
Milestone: 1.0 beta Component: django.contrib.comments
Version: Keywords:
Cc: Triage Stage: Accepted
Has patch: 0 Needs documentation: 0
Needs tests: 0 Patch needs improvement: 0

Description

The documentation for the comments are a little bit off:

http://jmoiron.net/~jmoiron/documentation_error.png

As you can see the free_comments_* tags and the comments_ tags show the same documentation but the tags are (of course) different. This is a side effect of the way that the tags are registered.. it tripped me up a little because the line in which I used this tag had a syntax error and when the docs told me I was wrong I dove into the code to make sure :)

(note: i'm going to go shrink that image a little :)

Attachments

Change History

06/02/06 00:04:08 changed by adrian

Ah, this is happening because both of the free_comments tags are generated from the same function, so they share a docstring, which is where the admin documentation gets its docs from.

08/05/06 18:47:57 changed by adrian

  • priority changed from normal to lowest.
  • status changed from new to assigned.
  • severity changed from minor to trivial.

11/26/06 19:20:21 changed by adrian

  • component changed from Admin interface to django.contrib.comments.

01/17/07 16:12:17 changed by

  • milestone deleted.

Milestone Version 1.0 deleted

01/31/07 21:44:19 changed by SmileyChris

  • stage changed from Unreviewed to Accepted.

I'll accept, but I hear comments are being rewritten anyway. Good to keep tabs on tickets like this though.

Add/Change #1853 (admin documentation section errors for 'comments' tags)




Change Properties
Action