Skip to content
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

Merged
merged 3 commits into from
Mar 6, 2024
Merged

Conversation

croyzor
Copy link
Contributor

@croyzor croyzor commented Feb 27, 2024

No description provided.

@croyzor croyzor requested a review from mark-koch February 27, 2024 16:18
@@ -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`
Copy link
Contributor Author

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

Copy link
Contributor

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?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done 👍

@aborgna-q aborgna-q changed the title doc(spec): Add note on serialized hugr node order docs(spec): Add note on serialized hugr node order Feb 27, 2024
Copy link

codecov bot commented Feb 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.20%. Comparing base (697e7d7) to head (828aaba).
Report is 3 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

@croyzor croyzor added this pull request to the merge queue Mar 6, 2024
Merged via the queue into main with commit eef8972 Mar 6, 2024
10 checks passed
@croyzor croyzor deleted the spec/node-order branch March 6, 2024 09:47
@github-actions github-actions bot mentioned this pull request Mar 6, 2024
@github-actions github-actions bot mentioned this pull request Apr 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants