ansible-doc: show correct plugin name (#71966) (#71984)

(cherry picked from commit 0c3a9c7ae6)
pull/72012/head
Felix Fontein 4 years ago committed by GitHub
parent 4df129c6ae
commit 8e00447aef
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -0,0 +1,2 @@
bugfixes:
- "ansible-doc - properly show plugin name when ``name:`` is used instead of ``<plugin_type>:`` (https://github.com/ansible/ansible/pull/71966)."

@ -385,7 +385,7 @@ class DocCLI(CLI):
text = DocCLI.get_snippet_text(doc) text = DocCLI.get_snippet_text(doc)
else: else:
try: try:
text = DocCLI.get_man_text(doc, collection_name) text = DocCLI.get_man_text(doc, collection_name, plugin_type)
except Exception as e: except Exception as e:
raise AnsibleError("Unable to retrieve documentation from '%s' due to: %s" % (plugin, to_native(e))) raise AnsibleError("Unable to retrieve documentation from '%s' due to: %s" % (plugin, to_native(e)))
@ -619,7 +619,7 @@ class DocCLI(CLI):
text.append('') text.append('')
@staticmethod @staticmethod
def get_man_text(doc, collection_name=''): def get_man_text(doc, collection_name='', plugin_type=''):
# Create a copy so we don't modify the original # Create a copy so we don't modify the original
doc = dict(doc) doc = dict(doc)
@ -629,7 +629,7 @@ class DocCLI(CLI):
pad = display.columns * 0.20 pad = display.columns * 0.20
limit = max(display.columns - int(pad), 70) limit = max(display.columns - int(pad), 70)
plugin_name = doc.get(context.CLIARGS['type'], doc.get('plugin_type')) plugin_name = doc.get(context.CLIARGS['type'], doc.get('name')) or doc.get('plugin_type') or plugin_type
if collection_name: if collection_name:
plugin_name = '%s.%s' % (collection_name, plugin_name) plugin_name = '%s.%s' % (collection_name, plugin_name)

Loading…
Cancel
Save