From dbe50ea95ceee5331f51588987ee42a7b4973174 Mon Sep 17 00:00:00 2001 From: Chris Dent Date: Wed, 13 Feb 2019 10:11:43 +0000 Subject: [PATCH] Add doc params to run and register_cli_opts The run and register_cli_opts methods were extracted to public in I3d7e28d2432f5b04d4154793025786dc289b0cb2 but were not as clearly documented as they should have been. This change improves the situation by adding param descriptions. Change-Id: I889bc08cda3b3850ccf7d9460851bae211272a4c --- oslo_upgradecheck/upgradecheck.py | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/oslo_upgradecheck/upgradecheck.py b/oslo_upgradecheck/upgradecheck.py index 2a7b850..b9076d6 100644 --- a/oslo_upgradecheck/upgradecheck.py +++ b/oslo_upgradecheck/upgradecheck.py @@ -146,6 +146,9 @@ def register_cli_options(conf, upgrade_command): Adds a subcommand to support 'upgrade check' on the command line. + :param conf: An oslo.confg ConfigOpts instance on which to register the + upgrade check arguments. + :param upgrade_command: The UpgradeCommands instance. """ def add_parsers(subparsers): upgrade_action = subparsers.add_parser('upgrade') @@ -157,7 +160,11 @@ def register_cli_options(conf, upgrade_command): def run(conf): - """Run the requested command.""" + """Run the requested command. + + :param conf: An oslo.confg ConfigOpts instance on which the upgrade + commands have been previously registered. + """ try: return conf.command.action_fn() except Exception: