From 48b963a66e368454e0ac78da682edb1651a37de8 Mon Sep 17 00:00:00 2001 From: Pedro Silva Date: Tue, 22 Oct 2013 21:46:46 +0200 Subject: [PATCH] Add docstring to new varargs callback ui function --- beets/ui/__init__.py | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/beets/ui/__init__.py b/beets/ui/__init__.py index cdcf778e2..d550d05a4 100644 --- a/beets/ui/__init__.py +++ b/beets/ui/__init__.py @@ -695,11 +695,19 @@ class SubcommandsOptionParser(optparse.OptionParser): return options, subcommand, suboptions, subargs -# callback for an option with variable arguments -# parser.add_option("-c", "--callback", dest="vararg_attr", -# action="callback", callback=vararg_callback) - def vararg_callback(option, opt_str, value, parser): + """Callback for an option with variable arguments. + Manually collect arguments right of a callback-action + option (ie. with action="callback"), and add the resulting + list to the destination var. + + Usage: + parser.add_option("-c", "--callback", dest="vararg_attr", + action="callback", callback=vararg_callback) + + Details: + http://docs.python.org/2/library/optparse.html#callback-example-6-variable-arguments + """ assert value is None value = []