Documentation should discourage the usage of doctests
|Reported by:||Dougal Matthews||Owned by:||Dougal Matthews|
|Has patch:||yes||Needs documentation:||no|
|Needs tests:||no||Patch needs improvement:||no|
At the moment the documentation described both doctest and unit tests without giving the reader and guidance to one or the other. It is generally agree'd that unit tests are a better choice. I have added a patch with a small patch that adds a note to reflect this.
However, I'm not sure if this reflects a bigger problem - should unit tests be described first and docetests second so that the reader doesn't read through that section only to find out its not recommended? Or should the note be added to the top and further emphasised?
Change History (14)
comment:1 Changed 6 years ago by
|Patch needs improvement:||unset|
comment:4 Changed 6 years ago by
|Owner:||changed from nobody to Dougal Matthews|
|Status:||new → assigned|
comment:7 Changed 6 years ago by
|Patch needs improvement:||set|
|Triage Stage:||Ready for checkin → Accepted|