readability enhancements

1 files changed, 5 insertions, 0 deletions

diff --git a/lib/python/qmk/cli/cformat.py b/lib/python/qmk/cli/cformat.py
index 0c209247d..91e650368 100644
--- a/lib/python/qmk/cli/cformat.py
+++ b/lib/python/qmk/cli/cformat.py
@@ -12,18 +12,23 @@ def main(cli):
     """Format C code according to QMK's style.
     """
     clang_format = ['clang-format', '-i']
+
+    # Find the list of files to format
     if not cli.args.files:
         for dir in ['drivers', 'quantum', 'tests', 'tmk_core']:
             for dirpath, dirnames, filenames in os.walk(dir):
                 if 'tmk_core/protocol/usb_hid' in dirpath:
                     continue
+
                 for name in filenames:
                     if name.endswith('.c') or name.endswith('.h') or name.endswith('.cpp'):
                         cli.args.files.append(os.path.join(dirpath, name))
 
+    # Run clang-format on the files we've found
     try:
         subprocess.run(clang_format + cli.args.files, check=True)
         cli.log.info('Successfully formatted the C code.')
+
     except subprocess.CalledProcessError:
         cli.log.error('Error formatting C code!')
         return False