mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
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
|
@ -48,19 +48,24 @@ for aclass in class_list:
|
||||||
if a in docs:
|
if a in docs:
|
||||||
oblist[name][a] = docs[a]
|
oblist[name][a] = docs[a]
|
||||||
else:
|
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
|
# loop is really with_ for users
|
||||||
if name == 'Task':
|
if name == 'Task':
|
||||||
oblist[name]['with_<lookup_plugin>'] = 'DEPRECATED: use ``loop`` instead, ``with_`` used to be how loops were defined, '
|
oblist[name]['with_<lookup_plugin>'] = 'The same as ``loop`` but magically adds the output of any lookup plugin to generate the item list.'
|
||||||
'it can use any available lookup plugin to generate the item list'
|
|
||||||
|
|
||||||
# local_action is implicit with action
|
# local_action is implicit with action
|
||||||
if 'action' in oblist[name]:
|
if 'action' in oblist[name]:
|
||||||
oblist[name]['local_action'] = 'Same as action but also implies ``delegate_to: localhost``'
|
oblist[name]['local_action'] = 'Same as action but also implies ``delegate_to: localhost``'
|
||||||
|
|
||||||
# remove unusable (used to be private?)
|
# remove unusable (used to be private?)
|
||||||
for nouse in ('loop_args'):
|
for nouse in ('loop_args', 'loop_with'):
|
||||||
if nouse in oblist[name]:
|
if nouse in oblist[name]:
|
||||||
del oblist[name][nouse]
|
del oblist[name][nouse]
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue