From bbe3cb3975f011b40d94c155bc0e80e0bd6ce391 Mon Sep 17 00:00:00 2001
From: Eli Flanagan <efx@users.noreply.github.com>
Date: Mon, 3 Feb 2020 15:29:53 -0500
Subject: add Lucretiel's documentation suggestion

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

(limited to 'src/args.rs')

diff --git a/src/args.rs b/src/args.rs
index ad5f1d6..95ddaf7 100644
--- a/src/args.rs
+++ b/src/args.rs
@@ -27,7 +27,10 @@ struct CLIArgs {
     #[structopt(name = "PATH", parse(from_os_str))]
     path: Option<PathBuf>,
 
-    /// name of an index file to serve by default
+    /// The name of a directory index file to serve, like "index.html"
+    ///
+    /// Normally, when miniserve serves a directory, it creates a listing for that directory.
+    /// However, if a directory contains this file, miniserve will serve that file instead.
     #[structopt(long, parse(from_os_str), name="index_file")]
     index: Option<PathBuf>,
 
-- 
cgit v1.2.3