diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,100 @@ +Changes +======= + +Version 1.1.0.1 +--------------- + +Documentation fixes + +Version 1.1 +----------- + +* Add a `Serial` instance for `Ratio` +* Add the `NonEmpty` wrapper for lists +* Add `listM` (the monadic version of `list`) +* Add optional explanation for test outcomes + +Version 1.0.4 +------------- + +Fix compatibility with GHC 7.4.1 + +Version 1.0.3 +------------- + +Fix a bug where no test cases were generated for some functional types (#19). + +Version 1.0.2 +------------- + +Fix a bug in the generic instance + +Version 1.0.1 +------------- + +Make SmallCheck build with GHC 7.4 + +Version 1.0 +----------- + +This is a major incompatible release of SmallCheck. Virtually every function has +changed its name, type, semantics or module. So please carefully read the docs +when upgrading. + +For some highlights, see [this blog post](http://ro-che.info/articles/2013-02-19-smallcheck.html). + +Version 0.6.2 +----------- +* Derive Typeable Property instance +* Add smallCheckPure + +Version 0.6.1 +----------- + +* Documentation improvements +* Make the package build with GHC 7.4.1 + +Version 0.6 +----------- + +* Default Generic implementation of Serial instance (by Bas van Dijk) +* The code is split into modules +* Convert much of README into haddock documentation +* Many small API changes +* Remove impure Testable (IO a) instance + +Version 0.5 +----------- + +Make the package build with GHC 7.2. Some cosmetic changes. + +Version 0.4 +----------- + +The module SmallCheck is now Test.SmallCheck. Packaged with Cabal. + +Version 0.3 +----------- + +Existential quantifiers now have unique variants for which two witnesses +are reported when uniqueness fails. The over-generating coseries method +for functions of functional arguments has been replaced; now 'coseries' +and the 'alts' family take a series argument. Test counters are +now Integers, not Ints. Ord and Eq are now derived for the N types. +Examples extended. + +Version 0.2 +----------- + +The 'smallCheck' driver now takes an argument d and runs test series +at depths 0..d without interaction, stopping if any test fails. +The interactive variant is still available as 'smallCheckI'. All +Prelude numeric types now have Serial instances, including floating-point +types. Serial types Nat and Natural are also defined. Examples extended. + +Version 0.1 +----------- + +The differences from 0.0 are two fixes (space-fault, output buffering), +an 'unsafe' but sometimes useful Testable (IO a) instance and additional +examples. diff --git a/CHANGES.md b/CHANGES.md deleted file mode 100644 --- a/CHANGES.md +++ /dev/null @@ -1,95 +0,0 @@ -Changes -======= - -Version 1.1 ------------ - -* Add a `Serial` instance for `Ratio` -* Add the `NonEmpty` wrapper for lists -* Add `listM` (the monadic version of `list`) -* Add optional explanation for test outcomes - -Version 1.0.4 -------------- - -Fix compatibility with GHC 7.4.1 - -Version 1.0.3 -------------- - -Fix a bug where no test cases were generated for some functional types (#19). - -Version 1.0.2 -------------- - -Fix a bug in the generic instance - -Version 1.0.1 -------------- - -Make SmallCheck build with GHC 7.4 - -Version 1.0 ------------ - -This is a major incompatible release of SmallCheck. Virtually every function has -changed its name, type, semantics or module. So please carefully read the docs -when upgrading. - -For some highlights, see [this blog post](http://ro-che.info/articles/2013-02-19-smallcheck.html). - -Version 0.6.2 ------------ -* Derive Typeable Property instance -* Add smallCheckPure - -Version 0.6.1 ------------ - -* Documentation improvements -* Make the package build with GHC 7.4.1 - -Version 0.6 ------------ - -* Default Generic implementation of Serial instance (by Bas van Dijk) -* The code is split into modules -* Convert much of README into haddock documentation -* Many small API changes -* Remove impure Testable (IO a) instance - -Version 0.5 ------------ - -Make the package build with GHC 7.2. Some cosmetic changes. - -Version 0.4 ------------ - -The module SmallCheck is now Test.SmallCheck. Packaged with Cabal. - -Version 0.3 ------------ - -Existential quantifiers now have unique variants for which two witnesses -are reported when uniqueness fails. The over-generating coseries method -for functions of functional arguments has been replaced; now 'coseries' -and the 'alts' family take a series argument. Test counters are -now Integers, not Ints. Ord and Eq are now derived for the N types. -Examples extended. - -Version 0.2 ------------ - -The 'smallCheck' driver now takes an argument d and runs test series -at depths 0..d without interaction, stopping if any test fails. -The interactive variant is still available as 'smallCheckI'. All -Prelude numeric types now have Serial instances, including floating-point -types. Serial types Nat and Natural are also defined. Examples extended. - -Version 0.1 ------------ - -The differences from 0.0 are two fixes (space-fault, output buffering), -an 'unsafe' but sometimes useful Testable (IO a) instance and additional -examples. diff --git a/Test/SmallCheck.hs b/Test/SmallCheck.hs --- a/Test/SmallCheck.hs +++ b/Test/SmallCheck.hs @@ -75,15 +75,17 @@ -- * Running tests -- | 'smallCheck' is a simple way to run a test. -- - -- As an alternative, consider using the @test-framework@ package: - -- + -- As an alternative, consider using a testing framework. -- - -- It allows to organize SmallCheck properties into a test suite (possibly - -- together with HUnit or QuickCheck tests), apply timeouts, get nice - -- statistics etc. + -- The packages + -- and + -- + -- provide integration with Tasty and HSpec, two popular testing + -- frameworks. -- - -- To use SmallCheck properties with test-framework, install - -- the @test-framework-smallcheck@ package: + -- They allow to organize SmallCheck properties into a test suite (possibly + -- together with HUnit or QuickCheck tests) and provide other useful + -- features. -- -- For more ways to run the tests, see "Test.SmallCheck.Drivers". Depth, diff --git a/smallcheck.cabal b/smallcheck.cabal --- a/smallcheck.cabal +++ b/smallcheck.cabal @@ -1,5 +1,5 @@ Name: smallcheck -Version: 1.1 +Version: 1.1.0.1 Cabal-Version: >= 1.6 License: BSD3 License-File: LICENSE @@ -16,18 +16,13 @@ automatically by SmallCheck. Build-Type: Simple -Extra-source-files: README.md, CREDITS.md, CHANGES.md +Extra-source-files: README.md, CREDITS.md, CHANGELOG.md Source-repository head type: git location: git://github.com/feuerbach/smallcheck.git - -Source-repository this - type: git - location: git://github.com/feuerbach/smallcheck.git - tag: v1.1 Library