rust-lang/rust
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Address review comments to add "basic usage" sections to docs.

Browse Source
This commit is contained in:
Nathan Kleyn
2016-03-09 16:18:31 +00:00
parent 118b975c80
commit 04436fb65b
1 changed files with 38 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
src/libcollections/binary_heap.rs
View File

@@ -246,6 +246,8 @@ impl<T: Ord> BinaryHeap<T> {
/// ///
/// # Examples /// # Examples
/// ///
/// Basic usage:
///
/// ``` /// ```
/// use std::collections::BinaryHeap; /// use std::collections::BinaryHeap;
/// let mut heap = BinaryHeap::new(); /// let mut heap = BinaryHeap::new();
@@ -263,6 +265,8 @@ impl<T: Ord> BinaryHeap<T> {
/// ///
/// # Examples /// # Examples
/// ///
/// Basic usage:
///
/// ``` /// ```
/// use std::collections::BinaryHeap; /// use std::collections::BinaryHeap;
/// let mut heap = BinaryHeap::with_capacity(10); /// let mut heap = BinaryHeap::with_capacity(10);
@@ -278,6 +282,8 @@ impl<T: Ord> BinaryHeap<T> {
/// ///
/// # Examples /// # Examples
/// ///
/// Basic usage:
///
/// ``` /// ```
/// use std::collections::BinaryHeap; /// use std::collections::BinaryHeap;
/// let heap = BinaryHeap::from(vec![1, 2, 3, 4]); /// let heap = BinaryHeap::from(vec![1, 2, 3, 4]);
@@ -296,6 +302,8 @@ impl<T: Ord> BinaryHeap<T> {
/// ///
/// # Examples /// # Examples
/// ///
/// Basic usage:
///
/// ``` /// ```
/// use std::collections::BinaryHeap; /// use std::collections::BinaryHeap;
/// let mut heap = BinaryHeap::new(); /// let mut heap = BinaryHeap::new();
@@ -316,6 +324,8 @@ impl<T: Ord> BinaryHeap<T> {
/// ///
/// # Examples /// # Examples
/// ///
/// Basic usage:
///
/// ``` /// ```
/// use std::collections::BinaryHeap; /// use std::collections::BinaryHeap;
/// let mut heap = BinaryHeap::with_capacity(100); /// let mut heap = BinaryHeap::with_capacity(100);
@@ -340,6 +350,8 @@ impl<T: Ord> BinaryHeap<T> {
/// ///
/// # Examples /// # Examples
/// ///
/// Basic usage:
///
/// ``` /// ```
/// use std::collections::BinaryHeap; /// use std::collections::BinaryHeap;
/// let mut heap = BinaryHeap::new(); /// let mut heap = BinaryHeap::new();
@@ -361,6 +373,8 @@ impl<T: Ord> BinaryHeap<T> {
/// ///
/// # Examples /// # Examples
/// ///
/// Basic usage:
///
/// ``` /// ```
/// use std::collections::BinaryHeap; /// use std::collections::BinaryHeap;
/// let mut heap = BinaryHeap::new(); /// let mut heap = BinaryHeap::new();
@@ -377,6 +391,8 @@ impl<T: Ord> BinaryHeap<T> {
/// ///
/// # Examples /// # Examples
/// ///
/// Basic usage:
///
/// ``` /// ```
/// use std::collections::BinaryHeap; /// use std::collections::BinaryHeap;
/// let mut heap: BinaryHeap<i32> = BinaryHeap::with_capacity(100); /// let mut heap: BinaryHeap<i32> = BinaryHeap::with_capacity(100);
@@ -395,6 +411,8 @@ impl<T: Ord> BinaryHeap<T> {
/// ///
/// # Examples /// # Examples
/// ///
/// Basic usage:
///
/// ``` /// ```
/// use std::collections::BinaryHeap; /// use std::collections::BinaryHeap;
/// let mut heap = BinaryHeap::from(vec![1, 3]); /// let mut heap = BinaryHeap::from(vec![1, 3]);
@@ -418,6 +436,8 @@ impl<T: Ord> BinaryHeap<T> {
/// ///
/// # Examples /// # Examples
/// ///
/// Basic usage:
///
/// ``` /// ```
/// use std::collections::BinaryHeap; /// use std::collections::BinaryHeap;
/// let mut heap = BinaryHeap::new(); /// let mut heap = BinaryHeap::new();
@@ -440,6 +460,8 @@ impl<T: Ord> BinaryHeap<T> {
/// ///
/// # Examples /// # Examples
/// ///
/// Basic usage:
///
/// ``` /// ```
/// #![feature(binary_heap_extras)] /// #![feature(binary_heap_extras)]
/// ///
@@ -478,6 +500,8 @@ impl<T: Ord> BinaryHeap<T> {
/// ///
/// # Examples /// # Examples
/// ///
/// Basic usage:
///
/// ``` /// ```
/// #![feature(binary_heap_extras)] /// #![feature(binary_heap_extras)]
/// ///
@@ -508,6 +532,8 @@ impl<T: Ord> BinaryHeap<T> {
/// ///
/// # Examples /// # Examples
/// ///
/// Basic usage:
///
/// ``` /// ```
/// use std::collections::BinaryHeap; /// use std::collections::BinaryHeap;
/// let heap = BinaryHeap::from(vec![1, 2, 3, 4, 5, 6, 7]); /// let heap = BinaryHeap::from(vec![1, 2, 3, 4, 5, 6, 7]);
@@ -528,6 +554,8 @@ impl<T: Ord> BinaryHeap<T> {
/// ///
/// # Examples /// # Examples
/// ///
/// Basic usage:
///
/// ``` /// ```
/// use std::collections::BinaryHeap; /// use std::collections::BinaryHeap;
/// ///
@@ -628,6 +656,8 @@ impl<T: Ord> BinaryHeap<T> {
/// ///
/// # Examples /// # Examples
/// ///
/// Basic usage:
///
/// ``` /// ```
/// use std::collections::BinaryHeap; /// use std::collections::BinaryHeap;
/// let mut heap = BinaryHeap::from(vec![1, 3]); /// let mut heap = BinaryHeap::from(vec![1, 3]);
@@ -643,6 +673,8 @@ impl<T: Ord> BinaryHeap<T> {
/// ///
/// # Examples /// # Examples
/// ///
/// Basic usage:
///
/// ``` /// ```
/// use std::collections::BinaryHeap; /// use std::collections::BinaryHeap;
/// let mut heap = BinaryHeap::new(); /// let mut heap = BinaryHeap::new();
@@ -666,6 +698,8 @@ impl<T: Ord> BinaryHeap<T> {
/// ///
/// # Examples /// # Examples
/// ///
/// Basic usage:
///
/// ``` /// ```
/// use std::collections::BinaryHeap; /// use std::collections::BinaryHeap;
/// let mut heap = BinaryHeap::from(vec![1, 3]); /// let mut heap = BinaryHeap::from(vec![1, 3]);
@@ -688,6 +722,8 @@ impl<T: Ord> BinaryHeap<T> {
/// ///
/// # Examples /// # Examples
/// ///
/// Basic usage:
///
/// ``` /// ```
/// use std::collections::BinaryHeap; /// use std::collections::BinaryHeap;
/// let mut heap = BinaryHeap::from(vec![1, 3]); /// let mut heap = BinaryHeap::from(vec![1, 3]);
@@ -915,6 +951,8 @@ impl<T: Ord> IntoIterator for BinaryHeap<T> {
/// ///
/// # Examples /// # Examples
/// ///
/// Basic usage:
///
/// ``` /// ```
/// use std::collections::BinaryHeap; /// use std::collections::BinaryHeap;
/// let heap = BinaryHeap::from(vec![1, 2, 3, 4]); /// let heap = BinaryHeap::from(vec![1, 2, 3, 4]);