Code

Opened 5 years ago

Closed 5 years ago

Last modified 3 years ago

#9675 closed (fixed)

Docs about migrating from the old comment system: add note about urls.py

Reported by: automatthias Owned by: jacob
Component: Documentation Version: 1.0
Severity: Keywords:
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

It's worth mentioning that the entry from urls.py:

(r'^comments/', include('django.contrib.comments.urls.comments')),

Needs to be changed to:

(r'^comments/', include('django.contrib.comments.urls')),

Looking at #8571 shows that many poeple have had this problem.

Attachments (0)

Change History (10)

comment:1 in reply to: ↑ description Changed 5 years ago by automatthias

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset

comment:2 Changed 5 years ago by jacob

  • milestone set to 1.1
  • Triage Stage changed from Unreviewed to Accepted

comment:3 Changed 5 years ago by jacob

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

comment:4 Changed 5 years ago by idangazit

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

Looks like this was solved in r8557. Cannot find any references to (r'^comments/', include('django.contrib.comments.urls.comments')) anywhere in the docs; closing.

comment:5 Changed 5 years ago by automatthias

  • Resolution fixed deleted
  • Status changed from closed to reopened

idangazit, the lack of mentions of "(r'comments/', ..." in the docs is the original problem reported here.

comment:6 Changed 5 years ago by idangazit

That seems to be doubly incorrect, unless I'm missing something large here.

The issue reported above is that the module path for including the comments urlconf was incorrect. I've grepped through the docs and found that problem fixed in r8557.

The new issue that you bring up ("lack of mentions of the correct way to include urlconf") doesn't seem to be true, the correct urlconf gets prominent placement at the top of the comments docs in the Quick Start Guide, and again in the documentation on Including Other URLconfs.

I don't see a natural place in any of the other comments docs for a re-mentioning of the URLconf. I think that the comments docs could use some expansion but barring that, don't know what to do with this ticket.

comment:7 Changed 5 years ago by automatthias

If I understand correctly, the issue reported is:

"There is a bit of information that is not there in the docs, and it should be there."

In other words, there is something to add to the migration documentation. The bit to be added is (in quotes):

"""The entry from urls.py:

(r'^comments/', include('django.contrib.comments.urls.comments')),

Needs to be changed to:

(r'^comments/', include('django.contrib.comments.urls')),

"""

comment:8 Changed 5 years ago by jacob

  • Status changed from reopened to assigned

comment:9 Changed 5 years ago by jacob

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

(In [10746]) Fixed #9675: added note about upgrading the URLconf to the comment upgrade guide.

comment:10 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.