ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-04-24 11:21:25 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

Complain when modules do not have documentation.

Browse source
This commit is contained in:
Michael DeHaan 2012-09-30 21:10:07 -04:00
parent a2f76c1c69
commit 31a4fe412f
2 changed files with 23 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

10
hacking/module_formatter.py
View file

@ -30,6 +30,11 @@ import time
import datetime
import subprocess
# modules that are ok that they do not have documentation strings
BLACKLIST_MODULES = [
'async_wrapper'
]
MODULEDIR="/Users/jpm/Auto/pubgit/ansible/ansible/library"
BOILERPLATE = '''
@ -282,6 +287,11 @@ def main():
print " processing module source ---> %s" % fname
doc = get_docstring(fname, verbose=args.verbose)
if doc is None and module not in BLACKLIST_MODULES:
sys.stderr.write("*** ERROR: CORE MODULE MISSING DOCUMENTATION: %s ***\n" % module)
#sys.exit(1)
if not doc is None:
doc['filename'] = fname