Skip to content

docs: improve Windows include-order comments#1692

Open
MeowTyou wants to merge 1 commit into
hiero-ledger:mainfrom
MeowTyou:fix-windows-comments
Open

docs: improve Windows include-order comments#1692
MeowTyou wants to merge 1 commit into
hiero-ledger:mainfrom
MeowTyou:fix-windows-comments

Conversation

@MeowTyou

@MeowTyou MeowTyou commented Jul 9, 2026

Copy link
Copy Markdown

Fixes #1632

Summary by CodeRabbit

  • Documentation
    • Clarified build and include-order notes for Windows-related headers.
    • Improved guidance to help avoid macro collisions from system headers during compilation.
    • No functional behavior or public interfaces were changed.

Signed-off-by: MeowTyou <meowtyou466@gmail.com>
@MeowTyou MeowTyou requested review from a team as code owners July 9, 2026 07:00
@MeowTyou MeowTyou requested a review from rwalworth July 9, 2026 07:00
@coderabbitai

coderabbitai Bot commented Jul 9, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 1cd7f0d4-83d3-4899-b7a9-88864fb1061c

📥 Commits

Reviewing files that changed from the base of the PR and between a898153 and 9fdd531.

📒 Files selected for processing (4)
  • src/sdk/main/include/impl/BaseNode.h
  • src/sdk/main/src/AccountId.cc
  • src/sdk/main/src/FeeEstimateQuery.cc
  • src/tck/src/TckServer.cc

📝 Walkthrough

Walkthrough

Comment text in four source files was updated to more precisely explain why certain headers must be included before headers that transitively include <windows.h>, clarifying the cause as macro collisions with generated protobuf identifiers. No code logic or behavior was changed.

Changes

Include-order comment clarifications

Layer / File(s) Summary
Update Windows include-order comments
src/sdk/main/include/impl/BaseNode.h, src/sdk/main/src/AccountId.cc, src/sdk/main/src/FeeEstimateQuery.cc, src/tck/src/TckServer.cc
Replaced vague "Windows build requires this for some reason" comments with specific explanations that headers must precede any <windows.h>-pulling header to avoid macro collisions (e.g., GetMessage) with generated protobuf identifiers; no code or behavior changes.

Estimated code review effort: 1 (Trivial) | ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the comment-only Windows include-order documentation update.
Linked Issues check ✅ Passed The four requested files were updated with clearer Windows include-order comments and no code behavior changes.
Out of Scope Changes check ✅ Passed The changes stay within the documented comment cleanup scope and do not introduce unrelated modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown

Hey @MeowTyou 👋 thanks for the PR!
I'm your friendly PR Helper Bot 🤖 and I'll be riding shotgun on this one, keeping track of your PR's status to help you get it approved and merged.

This comment updates automatically as you push changes -- think of it as your PR's live scoreboard!
Here's the latest:


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!

@github-actions github-actions Bot added the status: needs review The pull request is ready for maintainer review label Jul 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

status: needs review The pull request is ready for maintainer review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Good First Issue]: Improve comments on Windows-specific include-ordering workarounds

1 participant