docs: fix links

Author: mpizenberg

src/solver.rs

@@ -203,7 +203,7 @@ pub fn resolve<P: Package, VS: VersionSet>(
 }
 
 /// An enum used by [DependencyProvider] that holds information about package dependencies.
-/// For each [Package] there is a [Range] of concrete versions it allows as a dependency.
+/// For each [Package] there is a set of versions allowed as a dependency.
 #[derive(Clone)]
 pub enum Dependencies<P: Package, VS: VersionSet> {
     /// Package dependencies are unavailable.
@@ -219,7 +219,7 @@ pub trait DependencyProvider<P: Package, VS: VersionSet> {
     /// is the process of choosing the next package
     /// and version that will be appended to the partial solution.
     /// Every time such a decision must be made,
-    /// potential valid packages and version ranges are preselected by the resolver,
+    /// potential valid packages and sets of versions are preselected by the resolver,
     /// and the dependency provider must choose.
     ///
     /// The strategy employed to choose such package and version

src/type_aliases.rs

@@ -9,10 +9,9 @@ pub type Map<K, V> = rustc_hash::FxHashMap<K, V>;
 /// from [DependencyConstraints].
 pub type SelectedDependencies<P, V> = Map<P, V>;
 
-/// Subtype of [Dependencies] which holds information about
-/// all possible versions a given package can accept.
-/// There is a difference in semantics between an empty [Map<P, Range<V>>](Map)
+/// Holds information about all possible versions a given package can accept.
+/// There is a difference in semantics between an empty map
 /// inside [DependencyConstraints] and [Dependencies::Unknown](crate::solver::Dependencies::Unknown):
 /// the former means the package has no dependencies and it is a known fact,
-/// while the latter means they could not be fetched by [DependencyProvider].
+/// while the latter means they could not be fetched by [DependencyProvider](crate::solver::DependencyProvider).
 pub type DependencyConstraints<P, VS> = Map<P, VS>;

src/version_set.rs

@@ -1,18 +1,22 @@
 // SPDX-License-Identifier: MPL-2.0
 
-//! Ranges are constraints defining sets of versions.
+//! As its name suggests, the [VersionSet] trait describes sets of versions.
 //!
-//! Concretely, those constraints correspond to any set of versions
-//! representable as the concatenation, union, and complement
-//! of the ranges building blocks.
+//! One needs to define
+//! - the associate type for versions,
+//! - two constructors for the empty set and a singleton set,
+//! - the complement and intersection set operations,
+//! - and a function to evaluate membership of versions.
 //!
-//! Those building blocks are:
-//!  - [none()](Range::none): the empty set
-//!  - [any()](Range::any): the set of all possible versions
-//!  - [exact(v)](Range::exact): the set containing only the version v
-//!  - [higher_than(v)](Range::higher_than): the set defined by `v <= versions`
-//!  - [strictly_lower_than(v)](Range::strictly_lower_than): the set defined by `versions < v`
-//!  - [between(v1, v2)](Range::between): the set defined by `v1 <= versions < v2`
+//! Two functions are automatically derived, thanks to the mathematical properties of sets.
+//! You can overwrite those implementations, but we highly recommend that you don't,
+//! except if you are confident in a correct implementation that brings much performance gains.
+//!
+//! It is also extremely important that the `Eq` trait is correctly implemented.
+//! In particular, you can only use `#[derive(Eq, PartialEq)]` if `Eq` is strictly equivalent to the
+//! structural equality, i.e. if versions have canonical representations.
+//! Such problems may arise if your implementations of `complement()` and `intersection()` do not
+//! return canonical representations so be careful there.
 
 use std::fmt::{Debug, Display};