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

Adds images to examples #127

Merged
merged 1 commit into from
Apr 1, 2023
Merged

Adds images to examples #127

merged 1 commit into from
Apr 1, 2023

Conversation

skrawcz
Copy link
Collaborator

@skrawcz skrawcz commented Apr 1, 2023

To make it simpler to grok what an example is doing. We should be leveraging this fact to always make it clear that you can provide this documentation if you use Hamilton!

Also fixes some minor bugs I found with one of the examples.

Changes

  • adds DAG images
  • fixes bug in data loader example
  • fixes typo in one doc string

How I tested this

  • ran the examples

Notes

Checklist

  • PR has an informative and human-readable title (this will be pulled into the release notes)
  • Changes are limited to a single goal (no scope creep)
  • Code passed the pre-commit check & code is left cleaner/nicer than when first encountered.
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future TODOs are captured in comments
  • Project documentation has been updated if adding/changing functionality.

To make it simpler to grok what an example is doing. We should be leveraging this fact
to always make it clear that you can provide this documentation if you use Hamilton!

Also fixes some minor bugs I found with one of the examples.
@skrawcz skrawcz requested a review from elijahbenizzy April 1, 2023 00:26
Copy link
Collaborator

@elijahbenizzy elijahbenizzy left a comment

Choose a reason for hiding this comment

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

Looked over, everything looks good!

@skrawcz skrawcz merged commit db97ef4 into main Apr 1, 2023
@skrawcz skrawcz deleted the add_dags_to_examples branch April 1, 2023 00:56
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