From 75ac071cd6e14c887fbb7526da8958b53aaf7198 Mon Sep 17 00:00:00 2001
From: Niko Matsakis <niko@alum.mit.edu>
Date: Tue, 12 Dec 2017 14:21:37 -0500
Subject: [PATCH] document return value of `add_live_point`

---
 src/librustc_mir/borrow_check/nll/region_infer/mod.rs | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/librustc_mir/borrow_check/nll/region_infer/mod.rs b/src/librustc_mir/borrow_check/nll/region_infer/mod.rs
index c1518b28dab..c926c7432bb 100644
--- a/src/librustc_mir/borrow_check/nll/region_infer/mod.rs
+++ b/src/librustc_mir/borrow_check/nll/region_infer/mod.rs
@@ -208,6 +208,9 @@ impl<'tcx> RegionInferenceContext<'tcx> {
     }
 
     /// Indicates that the region variable `v` is live at the point `point`.
+    ///
+    /// Returns `true` if this constraint is new and `false` is the
+    /// constraint was already present.
     pub(super) fn add_live_point(&mut self, v: RegionVid, point: Location) -> bool {
         debug!("add_live_point({:?}, {:?})", v, point);
         assert!(self.inferred_values.is_none(), "values already inferred");