Opened 3 years ago

Closed 3 years ago

Last modified 3 years ago

#18713 closed Uncategorized (fixed)

Use of multiple names in example for single app [Comments customization]

Reported by: Pratyush Owned by: nobody
Component: Documentation Version: 1.4
Severity: Normal Keywords: comments
Cc: Triage Stage: Unreviewed
Has patch: no Needs documentation:
Needs tests: Patch needs improvement:
Easy pickings: yes UI/UX: no

Description

The documentation on "customizing the comments framework" uses 'my_comment_app' for the comment app in the starting and the suddenly it refers to it as 'my_custom_app'.

Near the end, the documentation says: "Finally, we'll define a couple of methods in my_custom_app/init.py to point Django at these classes we've created:" and in the code following it again uses 'my_comment_app'.

from my_comments_app.models import CommentWithTitle
from my_comments_app.forms import CommentFormWithTitle

def get_model():
    return CommentWithTitle

def get_form():
    return CommentFormWithTitle

Change History (2)

comment:1 Changed 3 years ago by Claude Paroz <claude@…>

  • Resolution set to fixed
  • Status changed from new to closed

In [542c20b38263afb8161d354e6a2cc4ef6bb21de5]:

Fixed #18713 -- Fixed custom comment app name in comments docs

Thanks Pratyush for the report.

comment:2 Changed 3 years ago by Claude Paroz <claude@…>

In [49f9bb271dfeecca431398363e6683780ebcc70a]:

[1.4.x] Fixed #18713 -- Fixed custom comment app name in comments docs

Thanks Pratyush for the report.

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