From 200d3eb09eb369ad4f4243042d89772e3a28b783 Mon Sep 17 00:00:00 2001 From: Thomas Leonard Date: Fri, 28 Mar 2008 21:13:14 +0000 Subject: [PATCH] Describe function arguments for run module. --- zeroinstall/injector/run.py | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/zeroinstall/injector/run.py b/zeroinstall/injector/run.py index 8e19b6d..10946e0 100644 --- a/zeroinstall/injector/run.py +++ b/zeroinstall/injector/run.py @@ -24,7 +24,16 @@ def do_env_binding(binding, path): def execute(policy, prog_args, dry_run = False, main = None, wrapper = None): """Execute program. On success, doesn't return. On failure, raises an Exception. Returns normally only for a successful dry run. - + @param policy: a policy with the selected versions + @type policy: L{policy.Policy} + @param prog_args: arguments to pass to the program + @type prog_args: [str] + @param dry_run: if True, just print a message about what would have happened + @type dry_run: bool + @param main: the name of the binary to run, or None to use the default + @type main: str + @param wrapper: a command to use to actually run the binary, or None to run the binary directly + @type wrapper: str @precondition: C{policy.ready and policy.get_uncached_implementations() == []} """ iface = iface_cache.get_interface(policy.root) @@ -56,7 +65,16 @@ def _get_implementation_path(id): def execute_selections(selections, prog_args, dry_run = False, main = None, wrapper = None): """Execute program. On success, doesn't return. On failure, raises an Exception. Returns normally only for a successful dry run. - + @param selections: the selected versions + @type selections: L{selections.Selections} + @param prog_args: arguments to pass to the program + @type prog_args: [str] + @param dry_run: if True, just print a message about what would have happened + @type dry_run: bool + @param main: the name of the binary to run, or None to use the default + @type main: str + @param wrapper: a command to use to actually run the binary, or None to run the binary directly + @type wrapper: str @since: 0.27 @precondition: All implementations are in the cache. """ -- 2.11.4.GIT