From 2673cffa243d6d245637174a22bf959e91569ec0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Henrik=20tom=20W=C3=B6rden?= <henrik@trineo.org>
Date: Fri, 6 Dec 2019 17:11:43 +0100
Subject: [PATCH] MAINT: docs
---
src/caosadvancedtools/loadFiles.py | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
diff --git a/src/caosadvancedtools/loadFiles.py b/src/caosadvancedtools/loadFiles.py
index c6714aab..26907f76 100755
--- a/src/caosadvancedtools/loadFiles.py
+++ b/src/caosadvancedtools/loadFiles.py
@@ -90,8 +90,14 @@ def main(argv=None):
# Setup argument parser
parser = ArgumentParser()
parser.add_argument("-i", "--include", dest="include",
- help="only include paths matching this regex pattern. "
- "Note: exclude is given preference over include.",
+ help="""
+only include paths matching this regex pattern.
+Note: The provided directory tree is traversed from its root. I.e. a pattern
+like "/some/path/*.readme" will lead to no loading when called on "/some" as the
+re does not match "/some". If you want to match some file, make sure the parent
+directories are matched. E.g. -i "(/some|/some/path|.*readme).
+exclude is given preference over include.
+ """,
metavar="RE")
parser.add_argument("-e", "--exclude", dest="exclude",
help="exclude paths matching this regex pattern.",
--
GitLab