docs(spec): mention HUGR entrypoints #2775
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
croyzor
reviewed
Dec 22, 2025
| not be executable. | ||
| root Module node has a `FuncDefn` child node that is the designated entry point. This function must take no arguments as input. Modules that act as libraries need not be executable. | ||
|
|
||
| In Hugr, an entry point is just a distinguished node. This node could be a `FuncDefn` and its children would define the body of the function. This `FuncDefn` node, together with its children define a region of the HUGR graph. |
Contributor
There was a problem hiding this comment.
Can it be something other than a FuncDefn node?
Contributor
Author
There was a problem hiding this comment.
Can't a dataflow block be an entrypoint to a region? I could well be wrong.
Contributor
There was a problem hiding this comment.
I mean idk ottomh, but that would be my question if I was reading the spec. It seems from the bit about executable hugrs that entrypoints have to be FuncDefn
croyzor
reviewed
Dec 22, 2025
| root Module node has a `FuncDefn` child node that is the designated entry point. This function must take no arguments as input. Modules that act as libraries need not be executable. | ||
|
|
||
| In Hugr, an entry point is just a distinguished node. This node could be a `FuncDefn` and its children would define the body of the function. This `FuncDefn` node, together with its children define a region of the HUGR graph. | ||
| When performing optimizations or rewrites on the HUGR it may be desirable in some cases to optimize certain regions and leave others unchanged. |
Contributor
There was a problem hiding this comment.
This sentence doesn't really seem to fit in here
Contributor
Author
There was a problem hiding this comment.
I see what you mean. I did think this sort of thing would be worth mentioning somewhere though. I'll try and see if I can make it fit better.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
mainfunction as an entrypoint for execution.This is my first contribution to the spec so there may well be things I've missed out. Maybe entrypoints should have their own section? Not sure there's so much to say.
I've gone with "entry point" as opposed to "entrypoint" as this is consistent with what is already in the spec. However I'm quite used to seeing the later in function names, parameters, attributes etc.
Also not sure what I should say about dataflow entrypoints and the other varieties.
closes #2182