On Sat, Apr 18, 2009 at 8:06 AM, Daniel Joshua Worth
<pipemanmu...@gmail.com> wrote:
>> No - please don't. The Django docs explicitly state that Django's test
>> framework is based on Python's unittest and doctest frameworks, and
>> provides links to the docs for those frameworks. It's not our place to
>> including "how to use unittest" or "how to use doctest" documentation,
>> as we would be reproducing the documentation provided by Python. If
>> you feel that Python's docs don't make the prefix behaviour
>> sufficiently explicit, then this needs to be taken up with the Python
>> documentation team, not us.
>
> There is a helper box that explains what a doc string is. I don't think a
> few added words about naming convention would be overboard. I'm not married
> to the idea that all documentation needs to be exhaustingly detailed but a
> few words that mention it would have been nice. That being said I'm happy to
> file a report or not and I'm certainly not looking to start a flame war over
> it.

I can get behind the idea of a brief comment box - "tests start with
test_, see Python docs for details". I just don't want to see a
reproduction of the entire Python unittest documentation in the name
of a seamless Django experience. If you want to open a ticket for this
(and even write the patch - it shouldn't be too hard), I'll get it
into trunk.

Yours,
Russ Magee %-)

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

Reply via email to