#8956: doctests should not be used in regular documentation outside the orm
------------------------------------+---------------------------------------
Reporter: simon | Owner: nobody
Status: closed | Milestone:
Component: Uncategorized | Version: 1.0
Resolution: invalid | Keywords:
Stage: Unreviewed | Has_patch: 0
Needs_docs: 0 | Needs_tests: 0
Needs_better_patch: 0 |
------------------------------------+---------------------------------------
Changes (by mtredinnick):
* status: new => closed
* resolution: => invalid
Comment:
This ticket doesn't really make sense. Forbidding examples in docstrings
would be bad style. If there are places where the examples are confusing,
rather then enlightening, or drown out the real description, patches to
clarify/remove would be useful. If you're worried that people might think
those examples are actually run as tests, a patch to contributing.txt or a
patch to the testing framework to run the doctests would be useful.
But the general statement in the ticket description wouldn't be a good
road to go down. Docstrings should be as clear as possible and doctest
happened to choose (re-use) a style that was particularly clear. Using
that style without it being a doctest is fine.
--
Ticket URL: <http://code.djangoproject.com/ticket/8956#comment:2>
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
-~----------~----~----~----~------~----~------~--~---
