fix keyword doc generation
* use aliases when they exist * fix hardcoded loop attributes handling
This commit is contained in:
parent
c0cea32f61
commit
19fee0ef41
1 changed files with 9 additions and 4 deletions
|
@ -47,20 +47,25 @@ for aclass in class_list:
|
|||
for a in oblist[name]:
|
||||
if a in docs:
|
||||
oblist[name][a] = docs[a]
|
||||
else:
|
||||
# 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_<lookup_plugin>'] = '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_<lookup_plugin>'] = '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]
|
||||
|
||||
|
|
Loading…
Reference in a new issue