Make Index docs actually render

sfackler · sfackler · commit 11921b836ee7 · 2015-11-07T16:57:18.000-08:00
diff --git a/src/array.rs b/src/array.rs
@@ -192,34 +192,33 @@ tuple_impl!(a: isize, b: isize, c: isize, d: isize, e: isize, f: isize, g: isize
 tuple_impl!(a: isize, b: isize, c: isize, d: isize, e: isize, f: isize, g: isize, h: isize);
 tuple_impl!(a: isize, b: isize, c: isize, d: isize, e: isize, f: isize, g: isize, h: isize, i: isize);
 
+/// Indexes into the `Array`, retrieving a reference to the contained
+/// value.
+///
+/// Since `Array`s can be multi-dimensional, the `Index` trait is
+/// implemented for a variety of index types. In the most generic case, a
+/// `&[isize]` can be used. In addition, a bare `isize` as well as tuples
+/// of up to 10 `isize` values may be used for convenience.
+///
+/// # Panics
+///
+/// Panics if the index does not correspond to an in-bounds element of the
+/// `Array`.
+///
+/// # Examples
+///
+/// ```rust
+/// # use postgres_array::Array;
+/// let mut array = Array::from_vec(vec![0i32, 1, 2, 3], 0);
+/// assert_eq!(2, array[2]);
+///
+/// array.wrap(0);
+/// array.push(Array::from_vec(vec![4, 5, 6, 7], 0));
+///
+/// assert_eq!(6, array[(1, 2)]);
+/// ```
 impl<T, I: ArrayIndex> Index<I> for Array<T> {
     type Output = T;
-
-    /// Indexes into the `Array`, retrieving a reference to the contained
-    /// value.
-    ///
-    /// Since `Array`s can be multi-dimensional, the `Index` trait is
-    /// implemented for a variety of index types. In the most generic case, a
-    /// `&[isize]` can be used. In addition, a bare `isize` as well as tuples
-    /// of up to 10 `isize` values may be used for convenience.
-    ///
-    /// # Panics
-    ///
-    /// Panics if the index does not correspond to an in-bounds element of the
-    /// `Array`.
-    ///
-    /// # Examples
-    ///
-    /// ```rust
-    /// # use postgres_array::Array;
-    /// let mut array = Array::from_vec(vec![0i32, 1, 2, 3], 0);
-    /// assert_eq!(2, array[2]);
-    ///
-    /// array.wrap(0);
-    /// array.push(Array::from_vec(vec![4, 5, 6, 7], 0));
-    ///
-    /// assert_eq!(6, array[(1, 2)]);
-    /// ```
     fn index(&self, idx: I) -> &T {
         let idx = idx.index(self);
         &self.data[idx]
