From 19fee0ef41b9632d4fdf2e48a9bbcd69a651e603 Mon Sep 17 00:00:00 2001 From: Brian Coca Date: Mon, 30 Apr 2018 11:41:52 -0400 Subject: [PATCH] fix keyword doc generation * use aliases when they exist * fix hardcoded loop attributes handling --- docs/bin/dump_keywords.py | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/bin/dump_keywords.py b/docs/bin/dump_keywords.py index 455fc120864..3b1a3eaf565 100755 --- a/docs/bin/dump_keywords.py +++ b/docs/bin/dump_keywords.py @@ -48,19 +48,24 @@ for aclass in class_list: if a in docs: oblist[name][a] = docs[a] else: - oblist[name][a] = ' UNDOCUMENTED!! ' + # check if there is an alias, otherwise undocumented + alias = getattr(getattr(aobj, '_%s' % a), 'alias', None) + if alias and alias in docs: + oblist[name][alias] = docs[alias] + del oblist[name][a] + else: + oblist[name][a] = ' UNDOCUMENTED!! ' # loop is really with_ for users if name == 'Task': - oblist[name]['with_'] = 'DEPRECATED: use ``loop`` instead, ``with_`` used to be how loops were defined, ' - 'it can use any available lookup plugin to generate the item list' + oblist[name]['with_'] = 'The same as ``loop`` but magically adds the output of any lookup plugin to generate the item list.' # local_action is implicit with action if 'action' in oblist[name]: oblist[name]['local_action'] = 'Same as action but also implies ``delegate_to: localhost``' # remove unusable (used to be private?) - for nouse in ('loop_args'): + for nouse in ('loop_args', 'loop_with'): if nouse in oblist[name]: del oblist[name][nouse]