Merge pull request #233 from rustprooflabs/docs

Improve --input-file help message
rustprooflabs · Feb 25, 2022 · b065359 · b065359
2 parents 1de3fb6 + 644ccb2
commit b065359
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 5 deletions.
diff --git a/docker/pgosm_flex.py b/docker/pgosm_flex.py
@@ -1,8 +1,11 @@
 #!/usr/bin/env python3
-"""Python script to run PgOSM Flex.
+"""Python script to run PgOSM Flex within Docker container.
 
-Designed to be ran in Docker image:
+Docker image available on Docker Hub
     https://hub.docker.com/r/rustprooflabs/pgosm-flex
+
+Usage instructions:
+    https://github.com/rustprooflabs/pgosm-flex/blob/main/docs/DOCKER-RUN.md
 """
 import configparser
 import logging
@@ -45,7 +48,7 @@
 @click.option('--input-file',
               required=False,
               default=None,
-              help='Set explicit filepath to input osm.pbf file. Overrides default file handling, archiving, and MD5 checksum.')
+              help='Set filename or absolute filepath to input osm.pbf file. Overrides default file handling, archiving, and MD5 checksum validation. Filename is assumed under /app/output unless absolute path is used.')
 @click.option('--layerset', required=True,
               default='default',
               help='Layerset to load. Defines name of included layerset unless --layerset-path is defined.')

diff --git a/docs/DOCKER-RUN.md b/docs/DOCKER-RUN.md
@@ -129,8 +129,10 @@ Options:
   --data-only           When set, skips running Sqitch and importing QGIS
                         Styles.
   --debug               Enables additional log output
-  --input-file TEXT     Set explicit filepath to input osm.pbf file. Overrides
-                        default file handling, archiving, and MD5 checksum.
+  --input-file TEXT     Set filename or absolute filepath to input osm.pbf
+                        file. Overrides default file handling, archiving, and
+                        MD5 checksum validation. Filename is assumed under
+                        /app/output unless absolute path is used.
   --layerset TEXT       Layerset to load. Defines name of included layerset
                         unless --layerset-path is defined.  [required]
   --layerset-path TEXT  Custom path to load layerset INI from. Custom paths