fix: improve windows include comments#1678
Conversation
Signed-off-by: Mohit <mohityadav8@users.noreply.github.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
📝 WalkthroughWalkthroughFour file-header comments describing a Windows-specific include-order workaround are updated. The vague phrase "for some reason" is replaced with a precise explanation that the proto header must precede any header that pulls in ChangesWindows include-order comment clarification
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
Hey @mohityadav8 👋 thanks for the PR! This comment updates automatically as you push changes -- think of it as your PR's live scoreboard! PR Checks✅ DCO Sign-off -- All commits have valid sign-offs. Nice work! ✅ GPG Signature -- All commits have verified GPG signatures. Locked and loaded! ✅ Merge Conflicts -- No merge conflicts detected. Smooth sailing! ✅ Issue Link -- Linked to #1632 (assigned to you). 🎉 All checks passed! Your PR is ready for review. Great job! |
Description:
Improve Windows-specific include-ordering comments by replacing vague explanations with clear descriptions of the underlying macro-collision issue caused by
<windows.h>.<windows.h>Related issue(s):
Fixes #1632
Notes for reviewer:
This PR only updates code comments and does not introduce any functional or behavioral changes. The new comments explain the known Windows macro-collision issue (
GetMessage,SendMessage, etc.) that can interfere with protobuf-generated code and justify the include-ordering workaround.Checklist
Summary by CodeRabbit