|
From: David H. <neg...@gm...> - 2011-01-05 17:15:50
|
> I came to hate doctests more and more and I write new tests as unit > tests. Yay!!! :) > The tests that were left in the source code of configobj.py are only > ones I thought were useful as "documentation" in the docstrings. It is > possible that some of those should be deleted if they're duplicated in > the test file and are a maintenance burden. If you're no longer running doctests or encouraging others to, then if the stuff still in the source remains valuable from a reference/usage point of view it should probably at least be made to not look like doctests, and just appear as straight-up inline documentation. Otherwise people familiar with the format will think they're legitimately active tests and probably will adopt a 'when in rome' approach. If they're only of marginal doc value then I think they could be stripped out altogether. Both configobj and validate are well documented and that allows cleanliness and maintainability of the source code to have higher priority. regards, -hoss David Hostetler neg...@gm... |