Add comments to opportunistic resolve functions

jackh726 · jackh726 · commit c6e4284f8b78 · 2021-05-15T23:36:10.000-04:00
diff --git a/compiler/rustc_infer/src/infer/region_constraints/mod.rs b/compiler/rustc_infer/src/infer/region_constraints/mod.rs
@@ -623,10 +623,14 @@ impl<'tcx> RegionConstraintCollector<'_, 'tcx> {
         }
     }
 
+    /// 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>,

Original file line number	Diff line number	Diff line change
`@@ -623,10 +623,14 @@ impl<'tcx> RegionConstraintCollector<'_, 'tcx> {`
`623`	`623`	`}`
`624`	`624`	`}`
`625`	`625`
	`626`	`+ /// Resolves the passed RegionVid to the root RegionVid in the unification table`
`626`	`627`	`pub fn opportunistic_resolve_var(&mut self, rid: ty::RegionVid) -> ty::RegionVid {`
`627`	`628`	`self.unification_table().find(rid).vid`
`628`	`629`	`}`
`629`	`630`
	`631`	+ /// If the Region is a `ReVar`, then resolves it either to the root value in
	`632`	+ /// the unification table, if it exists, or to the root `ReVar` in the table.
	`633`	+ /// If the Region is not a `ReVar`, just returns the Region itself.
`630`	`634`	`pub fn opportunistic_resolve_region(`
`631`	`635`	`&mut self,`
`632`	`636`	`tcx: TyCtxt<'tcx>,`