Update documentation of into_refs()

neithernut · neithernut · commit a656581ed10b · 2018-04-30T15:59:57.000+02:00
Discourage users from using this function.
diff --git a/lib/src/gc.rs b/lib/src/gc.rs
@@ -167,8 +167,17 @@ impl<'r> CollectableRefs<'r>
         Ok(retval)
     }
 
-    /// Perform the computation of references to collect.
+    /// Find collectable references for multiple issues
     ///
+    /// This is a convenience function.
+    ///
+    /// # Note
+    ///
+    /// Internally, this function collects the references during the call.
+    /// Consider using the `for_issues` function in conjunction with
+    /// `flat_map()` on an issue iterator instead.
+    ///
+    #[deprecated]
     pub fn into_refs<I, J, K>(self, issues: I) -> Result<Vec<Reference<'r>>>
     where I: IntoIterator<Item = K, IntoIter = J>,
           J: Iterator<Item = K>,
