Opened 18 years ago
Closed 16 years ago
#1853 closed defect (invalid)
admin documentation section errors for 'comments' tags
Reported by: | Owned by: | nobody | |
---|---|---|---|
Component: | contrib.comments | Version: | |
Severity: | trivial | Keywords: | |
Cc: | Triage Stage: | Accepted | |
Has patch: | no | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | no | UI/UX: | no |
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 :)
Change History (7)
comment:1 by , 18 years ago
comment:2 by , 18 years ago
priority: | normal → lowest |
---|---|
Severity: | minor → trivial |
Status: | new → assigned |
comment:3 by , 18 years ago
Component: | Admin interface → django.contrib.comments |
---|
comment:5 by , 18 years ago
Triage Stage: | Unreviewed → Accepted |
---|
I'll accept, but I hear comments are being rewritten anyway. Good to keep tabs on tickets like this though.
comment:6 by , 16 years ago
milestone: | 1.0 beta |
---|
This is annoying, but really doesn't have to be a 1.0 fix.
comment:7 by , 16 years ago
Resolution: | → invalid |
---|---|
Status: | assigned → closed |
With the new comment system added in [8557], I'm closing all comment-related tickets since they're against an old system. Please open a new ticket for this issue if it still applies in the new system.
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.