in tools/check_documentation.py [0:0]
def main(dirs, exclude_file=None, files=False, show_diffs=False,
show_extra=False, show_summary=True):
'Cycle through modules and ensure READMEs are up-to-date.'
# print(f'files: {files}, extra: {show_extra}, diffs: {show_diffs}\n')
errors = []
for dir_name in dirs:
result = _check_dir(dir_name, exclude_file, files, show_extra)
for readme_path, state, diff in result:
if state.failed:
errors.append((readme_path, diff))
if show_summary:
print(f'[{state.label}] {readme_path}')
if errors:
print('\nErrored modules:\n')
for e in errors:
module, diff = e
print(f'- {module}')
if show_diffs:
print()
print(''.join(diff))
print()
print()
raise SystemExit('Errors found.')