20885: Update argument docstrings after pdoc migration
authorBrett Smith <brett.smith@curii.com>
Fri, 20 Oct 2023 15:57:45 +0000 (11:57 -0400)
committerPeter Amstutz <peter.amstutz@curii.com>
Tue, 28 Nov 2023 14:31:25 +0000 (09:31 -0500)
Update arvados.api_resources to use our new function argument format.

Refs #20885.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

sdk/python/discovery2pydoc.py

index 9f7f87d988e64534f196ff087a366be21dd6e9ff..151325228eda1ff2a65eeb1f843c1e40d8aeddaf 100755 (executable)
@@ -182,13 +182,17 @@ class Parameter(inspect.Parameter):
         if default_value is None:
             default_doc = ''
         else:
-            default_doc = f" Default {default_value!r}."
-        # If there is no description, use a zero-width space to help Markdown
-        # parsers retain the definition list structure.
-        description = self._spec['description'] or '\u200b'
+            default_doc = f"Default {default_value!r}."
+        description = self._spec['description']
+        doc_parts = [f'{self.api_name}: {self.annotation}']
+        if description or default_doc:
+            doc_parts.append('---')
+            if description:
+                doc_parts.append(description)
+            if default_doc:
+                doc_parts.append(default_doc)
         return f'''
-{self.api_name}: {self.annotation}
-: {description}{default_doc}
+* {' '.join(doc_parts)}
 '''