diff options
Diffstat (limited to 'tools/distrib/c-ish/check_documentation.py')
-rwxr-xr-x | tools/distrib/c-ish/check_documentation.py | 61 |
1 files changed, 26 insertions, 35 deletions
diff --git a/tools/distrib/c-ish/check_documentation.py b/tools/distrib/c-ish/check_documentation.py index 24da0051ad..fef8f4ee5d 100755 --- a/tools/distrib/c-ish/check_documentation.py +++ b/tools/distrib/c-ish/check_documentation.py @@ -22,24 +22,15 @@ import sys # where do we run _TARGET_DIRS = [ - 'include/grpc', - 'include/grpc++', - 'src/core', - 'src/cpp', - 'test/core', - 'test/cpp' + 'include/grpc', 'include/grpc++', 'src/core', 'src/cpp', 'test/core', + 'test/cpp' ] # which file extensions do we care about -_INTERESTING_EXTENSIONS = [ - '.c', - '.h', - '.cc' -] +_INTERESTING_EXTENSIONS = ['.c', '.h', '.cc'] # find our home -_ROOT = os.path.abspath( - os.path.join(os.path.dirname(sys.argv[0]), '../../..')) +_ROOT = os.path.abspath(os.path.join(os.path.dirname(sys.argv[0]), '../../..')) os.chdir(_ROOT) errors = 0 @@ -47,30 +38,30 @@ errors = 0 # walk directories, find things printed_banner = False for target_dir in _TARGET_DIRS: - for root, dirs, filenames in os.walk(target_dir): - if 'README.md' not in filenames: - if not printed_banner: - print 'Missing README.md' - print '=================' - printed_banner = True - print root - errors += 1 + for root, dirs, filenames in os.walk(target_dir): + if 'README.md' not in filenames: + if not printed_banner: + print 'Missing README.md' + print '=================' + printed_banner = True + print root + errors += 1 if printed_banner: print printed_banner = False for target_dir in _TARGET_DIRS: - for root, dirs, filenames in os.walk(target_dir): - for filename in filenames: - if os.path.splitext(filename)[1] not in _INTERESTING_EXTENSIONS: - continue - path = os.path.join(root, filename) - with open(path) as f: - contents = f.read() - if '\\file' not in contents: - if not printed_banner: - print 'Missing \\file comment' - print '======================' - printed_banner = True - print path - errors += 1 + for root, dirs, filenames in os.walk(target_dir): + for filename in filenames: + if os.path.splitext(filename)[1] not in _INTERESTING_EXTENSIONS: + continue + path = os.path.join(root, filename) + with open(path) as f: + contents = f.read() + if '\\file' not in contents: + if not printed_banner: + print 'Missing \\file comment' + print '======================' + printed_banner = True + print path + errors += 1 assert errors == 0, 'error count = %d' % errors |