From a0c7bd02583be62cac57942631649125c2ff6119 Mon Sep 17 00:00:00 2001 From: Ethan Dalool Date: Sat, 5 Dec 2020 20:19:14 -0800 Subject: [PATCH] Add docstring to pipeable.go. --- voussoirkit/pipeable.py | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/voussoirkit/pipeable.py b/voussoirkit/pipeable.py index 399a406..13f11ee 100644 --- a/voussoirkit/pipeable.py +++ b/voussoirkit/pipeable.py @@ -118,6 +118,16 @@ def output(line, end='\n'): sys.stdout.flush() def go(args=None, *input_args, **input_kwargs): + ''' + Automatically resolve all commandline arguments, or read from stdin if + there are no arguments. + + This function is only useful if you have *no other arguments* besides your + program's main data sink. You will not be able to use argparse in + conjunction with this function. If you want to support more arguments, + it's better to use a regular argparse argument which is then passed into + pipeable.input to resolve it for your data sink. + ''' if args is None: args = sys.argv[1:]