Opened 6 years ago

Closed 6 years ago

Last modified 5 years ago

#15154 closed (fixed)

Remove sample doctest from startapp tests.py stub

Reported by: Carl Meyer Owned by: nobody
Component: Core (Management commands) Version: master
Severity: Keywords:
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

Given the problems Django itself has experienced using doctests as a primary testing strategy, and the effort that's recently gone into removing them, do we really want to be encouraging Django users to adopt practices that have served us so poorly?

Seems like the sample doctest in the stub tests.py generated by startapp should probably go away.

Optionally, the Django testing docs could also be given a quick once-over to see if there are places we should be warning users against the siren song of using doctests as a primary test strategy.

Change History (3)

comment:1 Changed 6 years ago by Russell Keith-Magee

milestone: 1.3
Triage Stage: UnreviewedAccepted

Sounds good to me. After all, we've always been at war with doctests. :-)

The second optional point has already been done; unittest is listed in the docs before doctests, and the "which should I use" section has been beefed up to clarify the preference for unittests. Of course, if you have more specific suggestions, let's have 'em.

comment:2 Changed 6 years ago by Alex Gaynor

Resolution: fixed
Status: newclosed

(In [15314]) Fixed #15154 -- removed doctests from the tests.py generated with createapp.

comment:3 Changed 5 years ago by Jacob

milestone: 1.3

Milestone 1.3 deleted

Note: See TracTickets for help on using tickets.
Back to Top