From c3a0b4673ee794d3472ab0092be3e6a6d252f3d3 Mon Sep 17 00:00:00 2001 From: Mike McLean Date: Oct 31 2017 01:36:22 +0000 Subject: PR#645: don't fail on CLI plugins without docstrings Merges #645 https://pagure.io/koji/pull-request/645 Fixes: #644 https://pagure.io/koji/issue/644 CLI fails on plugins without docstrings --- diff --git a/cli/koji b/cli/koji index c88a0fb..ab4cdc5 100755 --- a/cli/koji +++ b/cli/koji @@ -275,7 +275,7 @@ def list_commands(categories_chosen=None): for category in categories_chosen: print(_("\n%s:" % categories[category])) for alias,handler in handlers: - desc = handler.__doc__ + desc = handler.__doc__ or '' if desc.startswith('[%s] ' % category): desc = desc[len('[%s] ' % category):] elif category != 'misc' or desc.startswith('['): diff --git a/docs/source/writing_a_plugin.rst b/docs/source/writing_a_plugin.rst index 7702867..51a2f83 100644 --- a/docs/source/writing_a_plugin.rst +++ b/docs/source/writing_a_plugin.rst @@ -206,6 +206,7 @@ Most simple command would look like this: @export_cli def anon_handle_echo(options, session, args): + "[info] Print arguments" usage = _("usage: %prog echo ") parser = OptionParser(usage=usage) (opts, args) = parser.parse_args(args)