Skip to content
Snippets Groups Projects
Commit 2673cffa authored by Henrik tom Wörden's avatar Henrik tom Wörden
Browse files

MAINT: docs

parent 8947cf9a
No related branches found
No related tags found
No related merge requests found
......@@ -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.",
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment