Opened 9 years ago

Closed 7 years ago

#1853 closed defect (invalid)

admin documentation section errors for 'comments' tags

Reported by: jmoiron@… 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: UI/UX:

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 Changed 9 years ago 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.

comment:2 Changed 9 years ago by adrian

  • priority changed from normal to lowest
  • Severity changed from minor to trivial
  • Status changed from new to assigned

comment:3 Changed 8 years ago by adrian

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

comment:4 Changed 8 years ago by anonymous

  • milestone Version 1.0 deleted

Milestone Version 1.0 deleted

comment:5 Changed 8 years ago by SmileyChris

  • Triage 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.

comment:6 Changed 7 years ago by jacob

  • milestone 1.0 beta deleted

This is annoying, but really doesn't have to be a 1.0 fix.

comment:7 Changed 7 years ago by jacob

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

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