On Tue, Oct 11, 2011 at 3:50 PM, Carl Meyer <c...@oddbird.net> wrote:

> After talking to Aymeric more on IRC, we agreed that this added docs
> page doesn't need to block the patch. The current documentation in the
> patch is adequate, this page would be an additional improvement. Which
> is good, because I'm not sure I have time to write that doc page right
> now :-) So I'm planning to commit the patch as-is and file a ticket for
> more docs with a link to this discussion.
>

+1 on the whole idea.

One thing that I think should be added before commit is a note in the
tutorial along the lines of "what if startproject didn't actually do what we
are saying it did?" and explaining that the structure has recently changed
and if you didn't get the structure described here than you are likely using
an older version of the code than the documentation you are reading and you
should get the two in sync.

This was done back in the day of changing maxlength to max_length, and  that
note stayed in the tutorial a laughably long time after the change was no
longer "recent", but it likely prevented lots of questions and duplicate bug
reports about the tutorial being wrong.

Karen

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

Reply via email to