From: Jack Huey <jack.huey@umassmed.edu>
Date: Sun, 16 May 2021 03:36:10 +0000 (-0400)
Subject: Add comments to opportunistic resolve functions
X-Git-Url: https://git.lizzy.rs/?a=commitdiff_plain;ds=sidebyside;h=c6e4284f8b786a700ca1a377c708a032240d34c8;p=rust.git

Add comments to opportunistic resolve functions
---

diff --git a/compiler/rustc_infer/src/infer/region_constraints/mod.rs b/compiler/rustc_infer/src/infer/region_constraints/mod.rs
index 69a33d46052..49359130162 100644
--- a/compiler/rustc_infer/src/infer/region_constraints/mod.rs
+++ b/compiler/rustc_infer/src/infer/region_constraints/mod.rs
@@ -623,10 +623,14 @@ pub fn glb_regions(
         }
     }
 
+    /// Resolves the passed RegionVid to the root RegionVid in the unification table
     pub fn opportunistic_resolve_var(&mut self, rid: ty::RegionVid) -> ty::RegionVid {
         self.unification_table().find(rid).vid
     }
 
+    /// If the Region is a `ReVar`, then resolves it either to the root value in
+    /// the unification table, if it exists, or to the root `ReVar` in the table.
+    /// If the Region is not a `ReVar`, just returns the Region itself.
     pub fn opportunistic_resolve_region(
         &mut self,
         tcx: TyCtxt<'tcx>,