Apply suggestions from code review

Co-authored-by: kirkrodrigues <[email protected]>

.github/workflows/build_wheels.yml

@@ -42,7 +42,8 @@ jobs:
 
       - uses: "actions/setup-python@v5"
         with:
-          # NOTE: CPython3.10 headers are used to resolve clang-tidy warnings
+          # NOTE: We resolve some of clang-tidy's IWYU violations using CPython 3.10's headers, so
+          # we need to use the same version of Python when running clang-tidy.
           python-version: "3.10"
 
       - run: |

README.md

@@ -320,7 +320,7 @@ in the table below.
 | `lint:cpp-fix`          | Runs the C++ linters and fixes some violations.         |
 | `lint:cpp-format-check` | Runs the C++ formatters.                                |
 | `lint:cpp-format-fix`   | Runs the C++ formatters and fixes some violations.      |
-| `lint:cpp-static-check` | Runs the C++ linters.                                   |
+| `lint:cpp-static-check` | Runs the C++ static analyzers.                          |
 | `lint:py-check`         | Runs the Python linters.                                |
 | `lint:py-fix`           | Runs the Python linters and fixes some violations.      |
 | `lint:yml-check`        | Runs the YAML linters.                                  |

lint-tasks.yml

@@ -5,9 +5,9 @@ vars:
   G_LINT_VENV_CHECKSUM_FILE: "{{.BUILD_DIR}}/lint#venv.md5"
   # Linter target dirs
   G_CPP_LINT_DIRS:
-    # TODO: before all clang-tidy warnings are resolved, we should maintain a list of files that
-    # doesn't have clang-tidy warnings, so that clang-tidy can be executed in the limited scope
-    # without failing existing workflows.
+    # TODO: Before all clang-tidy violations are resolved, we should only run clang-tidy on the
+    # files whose violations we've fixed, both to ensure they remain free of violations and so that
+    # the workflow doesn't fail due to violations in other files.
     - "{{.CLP_FFI_PY_CPP_SRC_DIR}}/Py_utils.cpp"
     - "{{.CLP_FFI_PY_CPP_SRC_DIR}}/Py_utils.hpp"
   G_PYTHON_LINT_DIRS: ["{{.ROOT_DIR}}/clp_ffi_py", "{{.ROOT_DIR}}/tests"]