OpenE2K/rust
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add doc comments mentioning unspecified behaviour upon exhaustion

Browse Source
This commit is contained in:
varkor 2018-05-16 21:19:17 +01:00
parent 1b3ecbcebb
commit ff0f00d318
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/libcore/ops/range.rs
View File

@ -360,6 +360,9 @@ impl<Idx> RangeInclusive<Idx> {
/// whether the inclusive range is empty, use the [`is_empty()`] method /// whether the inclusive range is empty, use the [`is_empty()`] method
/// instead of comparing `start() > end()`. /// 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 /// [`end()`]: #method.end
/// [`is_empty()`]: #method.is_empty /// [`is_empty()`]: #method.is_empty
/// ///
@ -381,6 +384,9 @@ impl<Idx> RangeInclusive<Idx> {
/// whether the inclusive range is empty, use the [`is_empty()`] method /// whether the inclusive range is empty, use the [`is_empty()`] method
/// instead of comparing `start() > end()`. /// 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 /// [`start()`]: #method.start
/// [`is_empty()`]: #method.is_empty /// [`is_empty()`]: #method.is_empty
/// ///
@ -395,7 +401,10 @@ impl<Idx> RangeInclusive<Idx> {
&self.end &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 /// # Examples
/// ///