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

Add clearer documentation #61

Closed
liamhuber opened this issue Nov 2, 2023 · 1 comment · Fixed by #70
Closed

Add clearer documentation #61

liamhuber opened this issue Nov 2, 2023 · 1 comment · Fixed by #70
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@liamhuber
Copy link
Member

Implementing Macro as a walled garden and Node.pull has helped clarify some of the specifications and class interactions in my mind -- in particular, I think I can now say more clear things about the run cycle, the concept of "upstream", and the concept of "parent". This includes the ideas about intended use and Workflow being "parent-most" and living and flexible while Macro is more crystallized, efficient, and suitable for composition (since it does not have the requirement to be parent-most). Some of this needs to be translated into class and module docs, but I think a very simple version should be added to the README too.

Additionally, the example notebook needs to be broken down into something like a "quickstart" for people who just want to get running, and a deeper dive for people who want to quickly learn the ins and outs of the codebase.

@liamhuber liamhuber self-assigned this Nov 2, 2023
@liamhuber liamhuber added the documentation Improvements or additions to documentation label Nov 3, 2023
@liamhuber
Copy link
Member Author

Everything else on my v0.1.0 checklist is done, but I don't expect to do this one over the weekend so let's leave it until after the Monday meeting and then hopefully incorporate some feedback from the ADIS workshop into the learning material.

@liamhuber liamhuber mentioned this issue Nov 6, 2023
11 tasks
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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant