[Django] #22836: Issue on the code in the documentation

11 views
Skip to first unread message

Django

unread,
Jun 14, 2014, 10:40:10 AM6/14/14
to django-...@googlegroups.com
#22836: Issue on the code in the documentation
--------------------------------------+--------------------
Reporter: anonymous | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 1.6
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 0 | UI/UX: 0
--------------------------------------+--------------------
https://docs.djangoproject.com/en/1.6/intro/tutorial05/#improving-our-view

I have made this tutorial and there was an issue loading the model or
queryset in the class.IndexView. After defining the Poll.model it worked.
Thanks for this nice comminity and all the work. Keep going ;)

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

Django

unread,
Jun 14, 2014, 11:40:16 AM6/14/14
to django-...@googlegroups.com
#22836: Issue on the code in the documentation
--------------------------------------+------------------------------------

Reporter: anonymous | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 1.6
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
--------------------------------------+------------------------------------
Changes (by bmispelon):

* needs_docs: => 0
* needs_better_patch: => 0
* needs_tests: => 0
* easy: 0 => 1
* stage: Unreviewed => Accepted


Comment:

Hi,

Do you mean that the `import` statements are missing at the top of the
code?

As mentionned in the introduction at the top of the page, part 5 of the
tutorial builds on part 4 where the `IndexView` should have been defined
already and that part has all the correct imports from what I can tell:
https://docs.djangoproject.com/en/1.6/intro/tutorial04/#amend-views

I'm not sure that reproducing all the imports in this section of part 5
would be so beneficial (but I'm open to hear your point of you if you
disagree).

However, I think there's one simple improvement we could make:

In the section you linked to, the "Tutorial 4" link points to the top of
the page, but it could be easier for the reader if it pointed to the
paragraph where the view has been defined, which is this one:
https://docs.djangoproject.com/en/1.6/intro/tutorial04/#amend-views


So I'm going to mark this ticket as `accepted` for this reason.

Thanks for your feedback!

--
Ticket URL: <https://code.djangoproject.com/ticket/22836#comment:1>

Django

unread,
Jun 19, 2014, 9:01:59 PM6/19/14
to django-...@googlegroups.com
#22836: Issue on the code in the documentation
--------------------------------------+------------------------------------
Reporter: anonymous | Owner: maxocub
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: master

Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
--------------------------------------+------------------------------------
Changes (by maxocub):

* owner: nobody => maxocub
* status: new => assigned
* version: 1.6 => master


--
Ticket URL: <https://code.djangoproject.com/ticket/22836#comment:2>

Django

unread,
Jun 19, 2014, 10:14:30 PM6/19/14
to django-...@googlegroups.com
#22836: Issue on the code in the documentation
--------------------------------------+------------------------------------
Reporter: anonymous | Owner: maxocub
Type: Cleanup/optimization | Status: assigned
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
--------------------------------------+------------------------------------
Changes (by maxocub):

* has_patch: 0 => 1


Comment:

Here's my [https://github.com/django/django/pull/2832 PR].

--
Ticket URL: <https://code.djangoproject.com/ticket/22836#comment:3>

Django

unread,
Jun 20, 2014, 8:16:27 AM6/20/14
to django-...@googlegroups.com
#22836: Issue on the code in the documentation
--------------------------------------+------------------------------------
Reporter: anonymous | Owner: maxocub
Type: Cleanup/optimization | Status: closed
Component: Documentation | Version: master
Severity: Normal | Resolution: fixed

Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
--------------------------------------+------------------------------------
Changes (by Tim Graham <timograham@…>):

* status: assigned => closed
* resolution: => fixed


Comment:

In [changeset:"608aa8d101b03004ed2181fac82d8f3d28253bbd"]:
{{{
#!CommitTicketReference repository=""
revision="608aa8d101b03004ed2181fac82d8f3d28253bbd"
Fixed #22836 -- Linked tutorial05 to the right section of tutorial04.
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/22836#comment:4>

Django

unread,
Jun 20, 2014, 8:17:42 AM6/20/14
to django-...@googlegroups.com
#22836: Issue on the code in the documentation
--------------------------------------+------------------------------------
Reporter: anonymous | Owner: maxocub
Type: Cleanup/optimization | Status: closed
Component: Documentation | Version: master
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
--------------------------------------+------------------------------------

Comment (by Tim Graham <timograham@…>):

In [changeset:"0b871ec22a3397063a0150d26efc0d1e1a293108"]:
{{{
#!CommitTicketReference repository=""
revision="0b871ec22a3397063a0150d26efc0d1e1a293108"
[1.7.x] Fixed #22836 -- Linked tutorial05 to the right section of
tutorial04.

Backport of 608aa8d101 from master
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/22836#comment:5>

Reply all
Reply to author
Forward
0 new messages