From 1fddc98a17f2d509149977b03c5d175d0c263a16 Mon Sep 17 00:00:00 2001
From: Mirus <lomirus.dev@protonmail.com>
Date: Sat, 23 Dec 2023 13:18:50 +0800
Subject: [PATCH] docs(listener): add more documentation comments

---
 src/lib.rs | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/src/lib.rs b/src/lib.rs
index 8dc7f2a..56fa8b0 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -43,7 +43,7 @@ pub struct Listener {
 }
 
 impl Listener {
-    /// Start live-server
+    /// Start live-server.
     ///
     /// ```
     /// use live_server::listen;
@@ -76,6 +76,9 @@ impl Listener {
     ///     assert_eq!(link, "http://127.0.0.1:8080");
     /// }
     /// ```
+    ///
+    /// This is useful when you did not specify the host or port (e.g. `listen("0.0.0.0:0", ".")`),
+    /// because this method will return the specific address.
     pub fn link(&self) -> Result<String, Box<dyn Error>> {
         let addr = self.tcp_listener.local_addr()?;
         let port = addr.port();