Skip to content

Commit cd23f59

Browse files
committed
Fix order_roots doc
1 parent 70efd80 commit cd23f59

File tree

1 file changed

+2
-7
lines changed

1 file changed

+2
-7
lines changed

src/unify/mod.rs

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -69,13 +69,8 @@ pub trait UnifyKey: Copy + Clone + Debug + PartialEq {
6969

7070
fn tag() -> &'static str;
7171

72-
/// If true, then `self` should be preferred as root to `other`.
73-
/// Note that we assume a consistent partial ordering, so
74-
/// returning true implies that `other.prefer_as_root_to(self)`
75-
/// would return false. If there is no ordering between two keys
76-
/// (i.e., `a.prefer_as_root_to(b)` and `b.prefer_as_root_to(a)`
77-
/// both return false) then the rank will be used to determine the
78-
/// root in an optimal way.
72+
/// You should return first the key that should be used as root,
73+
/// then the other key (that will then point to the new root).
7974
///
8075
/// NB. The only reason to implement this method is if you want to
8176
/// control what value is returned from `find()`. In general, it

0 commit comments

Comments
 (0)