Docs: Fix doc for optional parameters

BlueBrain · Sep 4, 2023 · 2177b44 · 2177b44
1 parent 3c493f5
commit 2177b44
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -171,7 +171,7 @@ def maybe_skip_member(app, what, name, obj, skip, options):
                 obj.docstring = cli.format_description(
                     actual_obj,
                     default_str="{doc}\n\n:default value: {default}",
-                    optional_str="(optional) {doc}",
+                    optional_str="(Optional) {doc}",
                     type_str="{doc}\n\n:type: {type}",
                     choices_str="{doc}\n\n:choices: {choices}",
                     interval_str="{doc}\n\n:permitted values: {interval}",

diff --git a/src/synthesis_workflow/tasks/cli.py b/src/synthesis_workflow/tasks/cli.py
@@ -68,7 +68,7 @@ def format_description(
     try:
         param_doc, param_type, choices, interval, optional = _process_param(param)
         if optional:
-            param_doc = optional_str + param_doc
+            param_doc = optional_str.format(doc=param_doc)
         if param_type is not None:
             param_doc = type_str.format(doc=param_doc, type=param_type.replace(":", ""))
         if choices is not None: