Apply suggestions from code review

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

CMakeLists.txt

@@ -132,8 +132,8 @@ set(CLP_FFI_PY_LIB_IR_SOURCES
     ${CLP_FFI_PY_LIB_SRC_DIR}/utils.hpp
 )
 
-# NOTE: These headers are wrappers of third-party dependency libraries. They are required to silence
-# clang-tidy warnings for missing direct includes.
+# NOTE: These headers are third-party facade headers wrapped with IWYU exports to resolve clang-tidy
+# violations for missing direct includes.
 set(CLP_FFI_PY_WRAPPED_DEPENDENCY_HEADERS
     ${CLP_FFI_PY_WRAPPED_DEPENDENCY_HEADERS_DIR}/msgpack.hpp
     ${CLP_FFI_PY_WRAPPED_DEPENDENCY_HEADERS_DIR}/Python.hpp

src/clp_ffi_py/.clang-format

@@ -12,8 +12,7 @@ IncludeCategories:
   # Third-party headers. Update when adding new third-party library
   - Regex: "<(clp|gsl|json|outcome)"
     Priority: 3
-  # Third-party headers with wrappers to silent clang-tidy warnings. Update when adding new
-  # third-party library
+  # Third-party facade headers wrapped with IWYU exports to resolve clang-tidy violations
   - Regex: "<wrapped_dependency_headers"
     Priority: 3
   # C headers

src/wrapped_dependency_headers/msgpack.hpp

@@ -6,7 +6,7 @@
 #ifdef CLP_FFI_PY_ENABLE_LINTING
 // Inform IWYU of the headers that we use that are exported by msgpack.hpp
 // IWYU pragma: begin_exports
-// TODO: add necessary msgpack internal headers to silent clang-tidy warnings
+// TODO: Add necessary msgpack internal headers to silence clang-tidy warnings
 // IWYU pragma: end_exports
 #endif
 // clang-format on