search

pubgrub-rs / pubgrub

PubGrub version solving algorithm implemented in Rust
https://pubgrub-rs.github.io/pubgrub/pubgrub/
Mozilla Public License 2.0
413 stars 36 forks source link

Rename v0.3 Range into BoundedRange #123

Open mpizenberg opened 2 years ago

mpizenberg commented 2 years ago

I'm currently writing the v0.2 -> v0.3 upgrade guide and realizing we still have the name Range for our default impl of VersionSet. However, this is not exactly the same as the previous v0.2 Range. So to prevent user confusion, and also make the upgrade guide clearer, I'd suggest we rename it to BoundedRange. That's also more precise since it's a range built with inclusive/exclusive bounds.

baszalmstra commented 2 years ago

Sounds good!

Michaelin007 commented 1 year ago

Hi, I would like to work on this issue. Where's the upgrade guide location? Thanks

mpizenberg commented 1 year ago

Hi @Michaelin007 thanks for your interest in this! The upgrade guide currently lives in the pubgrub-rs/guide repo, in a pull request I did not finish. https://github.com/pubgrub-rs/guide/pull/6

You might have to coordinate with @Eh2406 and @charliermarsh who started reading that guide and leaving some comments.

I'm not currently working on the guide so no need to coordinate with me. I'm happy to answer questions though.

Michaelin007 commented 1 year ago

Hi @mpizenberg noted. Thanks

Eh2406 commented 1 year ago

Let's focus on making the change here. We can deal with updating the guide once the code has been changed.

konstin commented 1 week ago

With the version-ranges crate split out (#262), the type's main name is now Ranges, which the old Range name being reexported for compatibility.