-
Notifications
You must be signed in to change notification settings - Fork 7
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs(spec): Add note on serialized hugr node order #849
Conversation
@@ -1556,8 +1556,8 @@ pseudocode, though we advocate MessagePack format in practice (see | |||
[Serialization implementation](schema/serialization.md)). | |||
Note in particular that hierarchical relationships | |||
have a special encoding outside `edges`, as a field `parent` | |||
in a node definition. | |||
The unique root node of the HUGR reports itself as the parent. | |||
in a node definition. Nodes are identified by their position in the `nodes` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is already said below, but I think it bears repeating because it's not super intuitive. I'd be glad to hear a rewording that makes it clearer though
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The wording sounds good to me. Maybe we should also clarify that the position is zero-based?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done 👍
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #849 +/- ##
==========================================
+ Coverage 84.04% 84.20% +0.16%
==========================================
Files 77 78 +1
Lines 14234 14280 +46
Branches 14234 14280 +46
==========================================
+ Hits 11963 12025 +62
+ Misses 1435 1420 -15
+ Partials 836 835 -1 ☔ View full report in Codecov by Sentry. |
No description provided.