X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/0f5b0542513b572959e39400bae42e69aeb1a7b6..82cda2c5df9bab00bd34481c349421217ae50dba:/sdk/python/discovery2pydoc.py diff --git a/sdk/python/discovery2pydoc.py b/sdk/python/discovery2pydoc.py index 9f7f87d988..6ca3aafeb6 100755 --- a/sdk/python/discovery2pydoc.py +++ b/sdk/python/discovery2pydoc.py @@ -49,8 +49,8 @@ _ALIASED_METHODS = frozenset([ ]) _DEPRECATED_NOTICE = ''' -!!! deprecated - This resource is deprecated in the Arvados API. +.. WARNING:: Deprecated + This resource is deprecated in the Arvados API. ''' _DEPRECATED_RESOURCES = frozenset([ 'Humans', @@ -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)} '''