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

Added details to docs for accessing variables on nodes and subgraphs #102

Merged
merged 1 commit into from
Apr 3, 2024

Conversation

dlcole3
Copy link
Collaborator

@dlcole3 dlcole3 commented Apr 3, 2024

I have gotten some feedback from some different people that the graphs are not always intuitive to someone with little optimization background, and when I was first using Plasmo, I did not understand how to acccess solutions or variables. I added to the gas network tutorial a section on querying solutions and accessing variables and explain the "nested" reference structure of nodes on subgraphs and variables on nodes.

@codecov-commenter
Copy link

codecov-commenter commented Apr 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.96%. Comparing base (1702300) to head (ff4f2b5).

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #102      +/-   ##
==========================================
+ Coverage   87.79%   87.96%   +0.16%     
==========================================
  Files          19       19              
  Lines        2368     2368              
==========================================
+ Hits         2079     2083       +4     
+ Misses        289      285       -4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jalving
Copy link
Member

jalving commented Apr 3, 2024

Thanks @dlcole3, better documentation is always welcome. You hit on some interesting points about how confusing this example can be with regard to ordering of subgraphs. Once the next release is done (it's getting close) we will revisit a lot of documentation updates and improved tutorials.

@jalving jalving merged commit fb7bda5 into plasmo-dev:main Apr 3, 2024
5 checks passed
@dlcole3
Copy link
Collaborator Author

dlcole3 commented Apr 3, 2024

Thanks @dlcole3, better documentation is always welcome. You hit on some interesting points about how confusing this example can be with regard to ordering of subgraphs. Once the next release is done (it's getting close) we will revisit a lot of documentation updates and improved tutorials.

No problem @jalving. I would also like to add some details on the aggregation mapping, but I have not gotten to that yet. I had another grad student reach out to me about using the gas network model for a project they are working on, so I figured I would put this information in the docs so that I could point them to it.

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.

3 participants