reem / rust-ordered-float

MIT License
221 stars 64 forks source link

Changelog or a clear list of breaking changes between releases? #140

Closed pacak closed 1 year ago

pacak commented 1 year ago
  1. I'm trying to update our codebase to the next release, code fails to compile. Usually it's a quick look at the changelog or release merge request, but neither seems to be available. Would be great to have this.

  2. Breaking change was introduced in #138 which requires to add a new constraint. Adding constraints is not a problem, but to add it I have to add a new dependency - num-traits which must be the same version (within cargo compatible versions) as ordered-float uses. This would break as soon as num-traits releases a new major version, usual approach is to reexport such traits so constraints can look like this instead:

fn problem<T>(inputs: &mut [OrderedFloat<T>])
where
    T: ordered_float::FloatCore,
{
    inputs.sort();
}
mbrubeck commented 1 year ago

There is a changelog here: https://github.com/reem/rust-ordered-float/releases

I should add a link to the README and docs to make it more discoverable.