Add doc comments mentioning unspecified behaviour upon exhaustion

This commit is contained in:
varkor
2018-05-16 21:19:17 +01:00
parent 1b3ecbcebb
commit ff0f00d318
+10 -1
View File
@@ -360,6 +360,9 @@ pub const fn new(start: Idx, end: Idx) -> Self {
/// whether the inclusive range is empty, use the [`is_empty()`] method
/// instead of comparing `start() > end()`.
///
/// Note: the value returned by this method is unspecified after the range
/// has been iterated to exhaustion.
///
/// [`end()`]: #method.end
/// [`is_empty()`]: #method.is_empty
///
@@ -381,6 +384,9 @@ pub fn start(&self) -> &Idx {
/// whether the inclusive range is empty, use the [`is_empty()`] method
/// instead of comparing `start() > end()`.
///
/// Note: the value returned by this method is unspecified after the range
/// has been iterated to exhaustion.
///
/// [`start()`]: #method.start
/// [`is_empty()`]: #method.is_empty
///
@@ -395,7 +401,10 @@ pub fn end(&self) -> &Idx {
&self.end
}
/// Destructures the RangeInclusive into (lower bound, upper (inclusive) bound).
/// Destructures the `RangeInclusive` into (lower bound, upper (inclusive) bound).
///
/// Note: the value returned by this method is unspecified after the range
/// has been iterated to exhaustion.
///
/// # Examples
///