Skip to content

Commit

Permalink
release: prepare for 1.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
BurntSushi committed Dec 27, 2020
1 parent c773663 commit 480a879
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 17 deletions.
1 change: 0 additions & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ members = ["quickcheck_macros"]

[features]
default = ["regex", "use_logging"]
unstable = []
use_logging = ["log", "env_logger"]
regex = ["env_logger/regex"]

Expand Down
29 changes: 13 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ mod tests {
This example uses the `quickcheck!` macro, which is backwards compatible with
old versions of Rust.

### The `#[quickcheck]` attribute (requires Rust 1.30 or later)
### The `#[quickcheck]` attribute

To make it easier to write QuickCheck tests, the `#[quickcheck]` attribute
will convert a property function into a `#[test]` function.
Expand Down Expand Up @@ -95,23 +95,23 @@ mod tests {

```toml
[dependencies]
quickcheck = "0.9"
quickcheck = "1"
```

If you're only using `quickcheck` in your test code, then you can add it as a
development dependency instead:

```toml
[dev-dependencies]
quickcheck = "0.9"
quickcheck = "1"
```

If you want to use the `#[quickcheck]` attribute, then add `quickcheck_macros`

```toml
[dev-dependencies]
quickcheck = "0.9"
quickcheck_macros = "0.9"
quickcheck = "1"
quickcheck_macros = "1"
```

N.B. When using `quickcheck` (either directly or via the attributes),
Expand All @@ -121,17 +121,11 @@ witnesses for failures.

Crate features:

- `"unstable"`: Enables Arbitrary implementations that require the Rust nightly
channel.
- `"use_logging"`: (Enabled by default.) Enables the log messages governed
`RUST_LOG`.
- `"regex"`: (Enabled by default.) Enables the use of regexes with
`env_logger`.

Prior to quickcheck 0.8, this crate had an `i128` feature for enabling support
for 128-bit integers. As of quickcheck 0.8 this feature is now provided by
default and thus no longer available.


### Minimum Rust version policy

Expand Down Expand Up @@ -576,11 +570,14 @@ passing.

I think I've captured the key features, but there are still things missing:

* As of now, only functions with 8 or fewer parameters can be quickchecked.
This limitation can be lifted to some `N`, but requires an implementation
for each `n` of the `Testable` trait.
* Only functions with 8 or fewer parameters can be quickchecked. This
limitation can be lifted to some `N`, but requires an implementation for each
`n` of the `Testable` trait.
* Functions that fail because of a stack overflow are not caught by QuickCheck.
Therefore, such failures will not have a witness attached
to them. (I'd like to fix this, but I don't know how.)
* `Coarbitrary` does not exist in any form in this package. I think it's
possible; I just haven't gotten around to it yet.
* `Coarbitrary` does not exist in any form in this package. It's unlikely that
it ever will.
* `Arbitrary` is not implemented for closures. See
[issue #56](https://github.com/BurntSushi/quickcheck/issues/56)
for more details on why.

0 comments on commit 480a879

Please sign in to comment.