From ebb9e270d3c0820ae704abcadce85a45291c5ed2 Mon Sep 17 00:00:00 2001 From: Florian Bruhin Date: Sat, 2 Aug 2014 23:57:34 +0200 Subject: [PATCH] Avoid None values in documentation. --- scripts/generate_doc.py | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/scripts/generate_doc.py b/scripts/generate_doc.py index 200d38b4b..531a0a32b 100755 --- a/scripts/generate_doc.py +++ b/scripts/generate_doc.py @@ -185,9 +185,14 @@ def _get_command_doc(name, cmd): output.append("") for arg, desc in arg_descs.items(): text = ' '.join(desc).splitlines() - item = "* +{}+: {}".format(arg, text[0]) + firstline = text[0].replace(', or None', '') + item = "* +{}+: {}".format(arg, firstline) if arg in defaults: - item += " (default: +{}+)\n".format(defaults[arg]) + val = defaults[arg] + if val is None: + item += " (optional)\n" + else: + item += " (default: +{}+)\n".format(defaults[arg]) item += '\n'.join(text[1:]) output.append(item) output.append("")