Re: [Configobj-develop] On the included tests

[Michael F. <fuz...@vo...>]

On 05/01/2011 17:15, David Hostetler wrote:
>> 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.

Well - actually the *only* good use of doctests is to make examples 
executable (and therefore signal if the example break). If the tests 
currently inline can be made to look better whilst retaining testability 
then I'd be open to that change.


> 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.
>
Ones that are of marginal doc value can definitely be stripped out.


Michael

> regards,
>
> -hoss
>
> David Hostetler
> neg...@gm...
>
> ------------------------------------------------------------------------------
> Learn how Oracle Real Application Clusters (RAC) One Node allows customers
> to consolidate database storage, standardize their database environment, and,
> should the need arise, upgrade to a full multi-node Oracle RAC database
> without downtime or disruption
> http://p.sf.net/sfu/oracle-sfdevnl
> _______________________________________________
> Configobj-develop mailing list
> Con...@li...
> https://lists.sourceforge.net/lists/listinfo/configobj-develop


-- 
http://www.voidspace.org.uk/

May you do good and not evil
May you find forgiveness for yourself and forgive others
May you share freely, never taking more than you give.
-- the sqlite blessing http://www.sqlite.org/different.html