BurntSushi / quickcheck

Automated property based testing for Rust (with shrinking).
The Unlicense
2.32k stars 144 forks source link

upgrade notes would be nice. #302

Closed gilescope closed 2 years ago

gilescope commented 2 years ago

gen_range for example all disappear when moving to 1.0. It would be nice if there was a CHANGELOG giving some hints as to how to upgrade from earlier versions. (Otherwise people will just stick on 0.9 for way too long).

I can see there's now a choose that takes a slice not a range...

fill_bytes would be another one to document the migration of, and then what to do about when you try and sample from a distribution, but now gen is not a RndCore:

let dist = WeightedIndex::new([8, 4, 2, 1].iter()).unwrap();
let code = match dist.sample(gen)

For an example of amazing upgrade notes I'd point to pyo3 as going above and beyond: https://pyo3.rs/v0.14.5/migration.html

BurntSushi commented 2 years ago

I don't have the bandwidth to publish upgrade notes, sorry.

There are a few open issues/PRs attempting to solve the problem of the more restricted API and I just haven't been able to find time for it.