manually merge changes from #30

berkowski · Dec 31, 2024 · 7d94933 · 7d94933
1 parent 54e124a
commit 7d94933
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -101,6 +101,16 @@ impl SerialStream {
     /// Attempting any IO or parameter settings on the slave tty after the master
     /// tty is closed will return errors.
     ///
+    /// ## Examples
+    ///
+    /// ```rust
+    /// use tokio_serial::Serial;
+    ///
+    /// #[tokio::main]
+    /// async fn main() {
+    ///     let (master, slave) = Serial::pair().unwrap();
+    /// }
+    /// ```
     #[cfg(unix)]
     pub fn pair() -> crate::Result<(Self, Self)> {
         let (master, slave) = mio_serial::SerialStream::pair()?;