Merge pull request #286 from mitre/update-readme

Update reame and remove directories help message
mitre · Jul 31, 2024 · 612b175 · 612b175
2 parents 8c4cb8f + 4bfebc0
commit 612b175
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/README.rst b/README.rst
@@ -67,7 +67,7 @@ Quick Reference
       -b, --base-url TEXT           Base URL where Thumbtack is hosted on the server  [default: /]
       --path-contains TEXT          Only select files containing specified string in the path
       -s, --skip-subdirectory TEXT  Subdirectory to ignore when monitoring files
-      -r, --remove-directories      Remove empty directories in the mount directory on startup.
+      -r, --remove-directories      Unmount all mountpoints and remove all empty directories in the thumbtack mount directory
       --help                        Show this message and exit.
 
 LICENSE

diff --git a/docs/tutorial.rst b/docs/tutorial.rst
@@ -118,7 +118,7 @@ See them below.
       -b, --base-url TEXT           Base URL where Thumbtack is hosted on the server  [default: /]
       --path-contains TEXT          Only select files containing specified string in the path
       -s, --skip-subdirectory TEXT  Subdirectory to ignore when monitoring files
-      -r, --remove-directories      Remove empty directories in the mount directory on startup.
+      -r, --remove-directories      Unmount all mountpoints and remove all empty directories in the thumbtack mount directory
       --help                        Show this message and exit.
 
 Development Environment

diff --git a/src/thumbtack/__init__.py b/src/thumbtack/__init__.py
@@ -178,7 +178,7 @@ def configure_logging(app):
     "--remove-directories",
     default=False,
     is_flag=True,
-    help="Remove empty directories in the mount directory on startup.",
+    help="Unmount all mountpoints and remove all empty directories in the thumbtack mount directory",
 )
 def start_app(debug, host, port, mount_dir, image_dir, database, base_url, path_contains, skip_subdirectory, remove_directories):
     app = create_app(