voussoir/voussoirkit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add docstring to pipeable.go.

Browse source
This commit is contained in:
voussoir 2020-12-05 20:19:14 -08:00
parent 8fe13e0f83
commit a0c7bd0258
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
voussoirkit/pipeable.py
View file

@ -118,6 +118,16 @@ def output(line, end='\n'):
sys.stdout.flush() sys.stdout.flush()
def go(args=None, *input_args, **input_kwargs): 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: if args is None:
args = sys.argv[1:] args = sys.argv[1:]