#17145: Documentation lacking import paths
-------------------------------+--------------------------------------
     Reporter:  drozzy@…       |                    Owner:  nobody
         Type:  Bug            |                   Status:  new
    Component:  Documentation  |                  Version:  1.3
     Severity:  Normal         |               Resolution:
     Keywords:  imports        |             Triage Stage:  Unreviewed
    Has patch:  0              |      Needs documentation:  0
  Needs tests:  0              |  Patch needs improvement:  0
Easy pickings:  1              |                    UI/UX:  0
-------------------------------+--------------------------------------

Comment (by aaugustin):

 > where does one import !TemplateResponseMixin from?

 The reference page (your link) begins with a link to the topic page, where
 you can see that class-based generic views live in `django.views.generic`.

 ----

 > This has always been a problem throughout the Django docs.

 I agree that import paths must be included in the docs. But I don't find
 it realistic to keep a ticket that basically says "read all the docs and
 add missing import paths" — especially when that ticket doesn't come with
 a patch, so I'm reluctant to accept this.

 ----

 > Is there a way to consistently document this?

 The usual approach is to include import statement in code snippets.

-- 
Ticket URL: <https://code.djangoproject.com/ticket/17145#comment:2>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com.
To unsubscribe from this group, send email to 
django-updates+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/django-updates?hl=en.

Reply via email to