Clarify behavior of Sub/Equate type relationships.

rust-lang · Sep 16, 2015 · e567cb5 · e567cb5
1 parent 01872f7
commit e567cb5
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/src/librustc/middle/infer/equate.rs b/src/librustc/middle/infer/equate.rs
@@ -17,6 +17,7 @@ use middle::ty::{self, Ty};
 use middle::ty::TyVar;
 use middle::ty_relate::{Relate, RelateResult, TypeRelation};
 
+/// Ensures `a` is made equal to `b`. Returns `a` on success.
 pub struct Equate<'a, 'tcx: 'a> {
     fields: CombineFields<'a, 'tcx>
 }

diff --git a/src/librustc/middle/infer/sub.rs b/src/librustc/middle/infer/sub.rs
@@ -18,7 +18,7 @@ use middle::ty::TyVar;
 use middle::ty_relate::{Cause, Relate, RelateResult, TypeRelation};
 use std::mem;
 
-/// "Greatest lower bound" (common subtype)
+/// Ensures `a` is made a subtype of `b`. Returns `a` on success.
 pub struct Sub<'a, 'tcx: 'a> {
     fields: CombineFields<'a, 'tcx>,
 }