Wrapper::with_termwidth: expand docstring

mgeisler · Aug 24, 2017 · 0af87c0 · 0af87c0
1 parent d132b64
commit 0af87c0
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -247,6 +247,14 @@ impl<'a> Wrapper<'a, HyphenSplitter> {
     /// because the standard input and output is not connected to a
     /// terminal), a width of 80 characters will be used. Other
     /// settings use the same defaults as `Wrapper::new`.
+    ///
+    /// Equivalent to:
+    ///
+    /// ```
+    /// use textwrap::{Wrapper, termwidth};
+    ///
+    /// let wrapper = Wrapper::new(termwidth());
+    /// ```
     pub fn with_termwidth() -> Wrapper<'a, HyphenSplitter> {
         Wrapper::new(termwidth())
     }