From 7d07a1e74b1f0741777272e533b7eff452eb01e4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adolfo=20Ochagav=C3=ADa?= Date: Thu, 5 Jun 2014 09:33:49 +0200 Subject: [PATCH 1/2] Fix documentation for `slice()` Fixes https://github.com/mozilla/rust/issues/14577 --- src/libcollections/vec.rs | 4 ++-- src/libcore/slice.rs | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/libcollections/vec.rs b/src/libcollections/vec.rs index 1f2d176ab9b..aa80a131811 100644 --- a/src/libcollections/vec.rs +++ b/src/libcollections/vec.rs @@ -782,11 +782,11 @@ impl Vec { self.as_mut_slice().sort_by(compare) } - /// Returns a slice of `self` between `start` and `end`. + /// Returns a slice of self spanning the interval [`start`, `end`). /// /// # Failure /// - /// Fails when `start` or `end` point outside the bounds of `self`, or when + /// Fails when the slice (or part of it) is outside the bounds of self, or when /// `start` > `end`. /// /// # Example diff --git a/src/libcore/slice.rs b/src/libcore/slice.rs index 6312d9115ef..0257911e8c0 100644 --- a/src/libcore/slice.rs +++ b/src/libcore/slice.rs @@ -366,9 +366,9 @@ impl Container for ~[T] { /// Extension methods for vectors pub trait ImmutableVector<'a, T> { /** - * Returns a slice of self between `start` and `end`. + * Returns a slice of self spanning the interval [`start`, `end`). * - * Fails when `start` or `end` point outside the bounds of self, + * Fails when the slice (or part of it) is outside the bounds of self, * or when `start` > `end`. */ fn slice(&self, start: uint, end: uint) -> &'a [T]; From 75891274c461c8e097d8c0042df053dd01d3b43e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adolfo=20Ochagav=C3=ADa?= Date: Thu, 5 Jun 2014 09:40:43 +0200 Subject: [PATCH 2/2] Document BigInt's new and from_slice methods Fixes https://github.com/mozilla/rust/issues/14639 --- src/libnum/bigint.rs | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/libnum/bigint.rs b/src/libnum/bigint.rs index 4a848535b8d..67501c9795d 100644 --- a/src/libnum/bigint.rs +++ b/src/libnum/bigint.rs @@ -653,6 +653,8 @@ impl FromStrRadix for BigUint { impl BigUint { /// Creates and initializes a `BigUint`. + /// + /// The digits are be in base 2^32. #[inline] pub fn new(v: Vec) -> BigUint { // omit trailing zeros @@ -665,6 +667,8 @@ impl BigUint { } /// Creates and initializes a `BigUint`. + /// + /// The digits are be in base 2^32. #[inline] pub fn from_slice(slice: &[BigDigit]) -> BigUint { return BigUint::new(Vec::from_slice(slice)); @@ -1315,12 +1319,16 @@ impl RandBigInt for R { impl BigInt { /// Creates and initializes a BigInt. + /// + /// The digits are be in base 2^32. #[inline] pub fn new(sign: Sign, v: Vec) -> BigInt { BigInt::from_biguint(sign, BigUint::new(v)) } /// Creates and initializes a `BigInt`. + /// + /// The digits are be in base 2^32. #[inline] pub fn from_biguint(sign: Sign, data: BigUint) -> BigInt { if sign == Zero || data.is_zero() {