sascha/workload-automation
1
0
Fork 0
mirror of https://github.com/ARM-software/workload-automation.git synced 2025-10-31 07:04:17 +00:00
Code Issues Releases Wiki Activity

utils/doc: Rename get_rst_from_extension for consistency

Browse Source
This commit is contained in:
Marc Bonnici
2017-12-14 09:36:59 +00:00
committed by setrofim
parent 346ce2fb15
commit 9832db9fa5
1 changed files with 7 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
wa/utils/doc.py
View File

@@ -291,17 +291,16 @@ def underline(text, symbol='='):
return '{}\n{}\n\n'.format(text, symbol * len(text)) return '{}\n{}\n\n'.format(text, symbol * len(text))
def get_rst_from_extension(ext): def get_rst_from_plugin(plugin):
text = underline(ext.name, '-') text = underline(plugin.name, '-')
if hasattr(ext, 'description'): if hasattr(plugin, 'description'):
desc = strip_inlined_text(ext.description or '') desc = strip_inlined_text(plugin.description or '')
elif ext.__doc__: elif plugin.__doc__:
desc = strip_inlined_text(ext.__doc__) desc = strip_inlined_text(plugin.__doc__)
else: else:
desc = '' desc = ''
text += desc + '\n\n' text += desc + '\n\n'
params_rst = get_params_rst(ext.parameters) params_rst = get_params_rst(plugin.parameters)
if params_rst: if params_rst:
text += underline('parameters', '~') + params_rst text += underline('parameters', '~') + params_rst
return text + '\n' return text + '\n'