Rust Programming Cookbook

How to do it...

Here are the steps for this recipe:

1. Find a function or struct (or module) to add a documentation string, for example, the new_empty() function of List<T>:

    ///    /// Creates a new empty list.    ///     ///     pub fn new_empty() -> List<T> {         ...

2. Use the special (H1) section # Example to provide a cue for the compiler to run any snippet contained in that section:

    ///    /// Creates a new empty list.    ///     ///     /// # Example

3. Now let's add a code example. Since doctests are considered black box tests, we import the struct (only if it's public, of course) and show what we want to show:

    ///    /// Creates a new empty list.    ///     ///     /// # Example    ///     /// ```    /// use testing::List;    ///  /// let mut list: List<i32> = List::new_empty(); ...