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: improve description/naming for flat graph merge_in #1030

Closed
MingweiSamuel opened this issue Jan 13, 2024 · 1 comment
Closed

docs: improve description/naming for flat graph merge_in #1030

MingweiSamuel opened this issue Jan 13, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation hydroflow syntax Hydroflow's custom surface syntax wontfix This will not be worked on

Comments

@MingweiSamuel
Copy link
Member

The description I wrote of merge_in is not very helpful, I think we should point out that the Ends it returns are the input and output of the module that has been imported into self.

I also think that merge_in is kind of a misleading name, it's not really doing any 'merging'. I think a better name might be 'import_flatgraph', since what it returns is a handle to the imported flatgraph, and that handle can be used to complete the stitching.

Not sure about the second idea, but the first idea I think would be helpful.

Originally posted by @zzlk in #1017 (comment)

@MingweiSamuel MingweiSamuel added documentation Improvements or additions to documentation hydroflow syntax Hydroflow's custom surface syntax labels Jan 26, 2024
@MingweiSamuel MingweiSamuel added the wontfix This will not be worked on label May 23, 2024
@MingweiSamuel
Copy link
Member Author

#1110

@MingweiSamuel MingweiSamuel closed this as not planned Won't fix, can't repro, duplicate, stale May 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation hydroflow syntax Hydroflow's custom surface syntax wontfix This will not be worked on
Projects
None yet
Development

No branches or pull requests

1 participant