Re: Adding to or Updating the standard library
Jeremy Cowgar wrote:
>
> When adding to or updating the standard library, there are few things which
> we should all do consistently.
>
> #1... When altering the standard library at any time, the unit tests should
> be run to ensure things still work after your changes. If not, they should be
> fixed before committing.
>
> #2... When fixing a bug in the standard library, a unit test should first be
> created that exposes the bug. Unit tests should be run that that test should
> fail. The bug should then be fixed and the unit test should start working.
>
> #3... When adding a new function, we need an easy way to track it's status on
> two elements, 1. Has it been tested? 2. Has it been documented? So, What I've
> done from the start was added a comment to the top of any function that has
> 1 or more of these things not done:
>
> -- TODO: document, test
>
> Choose which one, or both needs to be done.
>
> However, when adding a function to the standard library, it should really be
> tested before being committed. Please take this step serious.
>
> #4.... (again) run unit tests.
>
> To run unit tests on Linux/FreeBSD
>
> cd $EUDIR/tests
> exu all.ex
>
> To run unit tests on Windows
>
> cd %EUDIR%\tests
> exwc all.ex
>
> --
> Jeremy Cowgar
> <a href="http://jeremy.cowgar.com">http://jeremy.cowgar.com</a>
Two questions:
1/ How to unit-test that something should crash?
2/ There are three folders related to documentation: doc, html and htx. Is it
proper to only modify the .htx file, as the other two will be generated anyway?
How would this procedure fit into ck's reworking the doc format?
CChris
|
Not Categorized, Please Help
|
|
