#15761: Clarity
-------------------------------------+-------------------------------------
Reporter: | Owner: nobody
chris.is.fun+django@… | Status: closed
Type: | Component: Documentation
Cleanup/optimization | Severity: Normal
Milestone: | Keywords: tutorial
Version: 1.3 | Has patch: 0
Resolution: wontfix | Needs tests: 0
Triage Stage: |
Unreviewed |
Needs documentation: 0 |
Patch needs improvement: 0 |
-------------------------------------+-------------------------------------
Changes (by lukeplant):
* status: new => closed
* needs_better_patch: => 0
* resolution: => wontfix
* needs_tests: => 0
* needs_docs: => 0
Comment:
First, regarding /django/contrib in tutorial part 2, there is no standard
place that this stuff is put, and we don't want to get into adding
information about where distributions put it - we cannot predict these
things, and it can easily change. Users need to know how to use the system
they are on to find out where files are put, I'm afraid.
For the second point, the text surrounding the example, as well as the
view code that is referenced, make it clear that 'poll' is a poll object,
i.e. an instance of Poll. It couldn't be anything else. It is standard
practice in Python to give classes singular names, and objects the same
name, but lower case, as the class they are an instance of. Shortening the
name to a single character doesn't help.
You seem to be confused also in this point - `{{ choice.choice }}` refers
to the ``choice`` attribute of the ``choice`` object. This is certainly a
potential source of confusion, but I think it is pretty clear once you've
gone through the first tutorial. The dot in between represents Python
attribute lookup, not set/member or member/set, which should be obvious to
anyone with minimal Python knowledge - and you can gain such minimal
knowledge by following the first part of the tutorial.
Final point - I think 'choice_set' is clear once you've gone through the
first tutorial, which encourages you to explore the API, and has lots of
examples. I don't really understand the objection here, because your
alternative is vulnerable to exactly the same objection - if it were
'answer_set' that could refer to the result of an SQL query or many other
sets of answers. In this context, given the API that has been demonstrated
in part 1, there really isn't anything else that 'choices_set' could be.
--
Ticket URL: <http://code.djangoproject.com/ticket/15761#comment:1>
Django <http://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 [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/django-updates?hl=en.
