Update add_parser_arguments comment

This commit is contained in:
Brad Warren 2016-03-31 20:11:53 -07:00
parent 8efc3ae7c8
commit 7e2e4192b4

View file

@ -45,15 +45,14 @@ class Plugin(object):
def add_parser_arguments(cls, add):
"""Add plugin arguments to the CLI argument parser.
NOTE: If some of your flags interact with others, you can
use cli.report_config_interaction to register this to ensure
values are correctly saved/overridable during renewal.
:param callable add: Function that proxies calls to
`argparse.ArgumentParser.add_argument` prepending options
with unique plugin name prefix.
NOTE: if you add argpase arguments such that users setting them can
create a config entry that python's bool() would consider false (ie,
the use might set the variable to "", [], 0, etc), please ensure that
cli.set_by_cli() works for your variable.
"""
@classmethod