Ticket #1724: tutorial01.txt.diff

docs/tutorial01.txt

@@ -4 +4 @@
 
 Let's learn by example.
 
-Throughout this tutorial, we'll walk you through the creation of a basic
-blogging application.
+Throughout this tutorial, we'll walk you through the creation of a survey
+(or poll) application.
 
 It'll consist of two parts:
 
-    * A public site that lets people read your blog entries and submit
-      comments.
-    * An admin site that lets you add, change and delete entries and comments.
+    * A public site that lets people select a choice in each available poll.
+    * An admin site that lets you add, change and delete questions and possible answers.
 
 We'll assume you have `Django installed`_ already. You can tell Django is
 installed by running the Python interactive interpreter and typing
@@ -491 +490 @@
 
     >>> from mysite.polls.models import Poll, Choice
 
-    # Make sure our __str__() addition worked.
+    # This still shows the __repr__ version of the object:
     >>> Poll.objects.all()
-    [What's up?]
+    [<Poll object>]
 
+    # Create a helper function to show the question (the __str__ output):
+    >>> def show(result_list):
+    ...     return [str(o) for o in result_list]
+    ...
+    >>> show(Poll.objects.all())
+    ["What's up?"]
+
     # Django provides a rich database lookup API that's entirely driven by
     # keyword arguments.
-    >>> Poll.objects.filter(id=1)
-    [What's up?]
-    >>> Poll.objects.filter(question__startswith='What')
-    [What's up?]
+    >>> show(Poll.objects.filter(id=1))
+    ["What's up?"]
+    >>> show(Poll.objects.filter(question__startswith='What'))
+    ["What's up?"]
 
     # Get the poll whose year is 2005. Of course, if you're going through this
     # tutorial in another year, change as appropriate.
-    >>> Poll.objects.get(pub_date__year=2005)
+    >>> print Poll.objects.get(pub_date__year=2005)
     What's up?
 
     >>> Poll.objects.get(id=2)
@@ -515 +521 @@
     # Lookup by a primary key is the most common case, so Django provides a
     # shortcut for primary-key exact lookups.
     # The following is identical to Poll.objects.get(id=1).
-    >>> Poll.objects.get(pk=1)
+    >>> print Poll.objects.get(pk=1)
     What's up?
 
     # Make sure our custom method worked.
@@ -528 +534 @@
     # of available choices and returns the new Choice object.
     >>> p = Poll.objects.get(pk=1)
     >>> p.choice_set.create(choice='Not much', votes=0)
-    Not much
+    <Choice object>
     >>> p.choice_set.create(choice='The sky', votes=0)
-    The sky
+    <Choice object>
     >>> c = p.choice_set.create(choice='Just hacking again', votes=0)
 
     # Choice objects have API access to their related Poll objects.
-    >>> c.poll
+    >>> print c.poll
     What's up?
 
     # And vice versa: Poll objects get access to Choice objects.
-    >>> p.choice_set.all()
-    [Not much, The sky, Just hacking again]
+    >>> show(p.choice_set.all())
+    ['Not much', 'The sky', 'Just hacking again']
     >>> p.choice_set.count()
     3
 
@@ -547 +553 @@
     # Use double underscores to separate relationships.
     # This works as many levels deep as you want. There's no limit.
     # Find all Choices for any poll whose pub_date is in 2005.
-    >>> Choice.objects.filter(poll__pub_date__year=2005)
-    [Not much, The sky, Just hacking again]
+    >>> show(Choice.objects.filter(poll__pub_date__year=2005))
+    ['Not much', 'The sky', 'Just hacking again']
 
     # Let's delete one of the choices. Use delete() for that.
     >>> c = p.choice_set.filter(choice__startswith='Just hacking')