From c0b20869d8bd9f88ac4435bfa5dbb38ae5596246 Mon Sep 17 00:00:00 2001 From: Arash Rouhani Date: Sat, 17 Nov 2018 17:33:55 +0100 Subject: [PATCH] Add some docs to interface.run Slightly related to issue #2577. --- luigi/interface.py | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/luigi/interface.py b/luigi/interface.py index 9d4c6254b0..fe09ff3e4f 100644 --- a/luigi/interface.py +++ b/luigi/interface.py @@ -217,22 +217,18 @@ class PidLockAlreadyTakenExit(SystemExit): def run(*args, **kwargs): - return _run(*args, **kwargs)['success'] - - -def _run(cmdline_args=None, main_task_cls=None, - worker_scheduler_factory=None, use_dynamic_argparse=None, local_scheduler=False): """ Please dont use. Instead use `luigi` binary. Run from cmdline using argparse. - :param cmdline_args: - :param main_task_cls: - :param worker_scheduler_factory: :param use_dynamic_argparse: Deprecated and ignored - :param local_scheduler: """ + return _run(*args, **kwargs)['success'] + + +def _run(cmdline_args=None, main_task_cls=None, + worker_scheduler_factory=None, use_dynamic_argparse=None, local_scheduler=False): if use_dynamic_argparse is not None: warnings.warn("use_dynamic_argparse is deprecated, don't set it.", DeprecationWarning, stacklevel=2)