updated README #963

zilto · 2024-06-14T20:43:42Z

Significant changes to README sections. Feel free to discuss things that should be:

reworded
added back
added to the docs instead
ordering

Changes

How I tested this

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.

README.md

skrawcz

approval based on adding tweaks -- see my suggestions.

elijahbenizzy

Looking good -- some comments on contents

README.md

elijahbenizzy

Looks good, just a few very small comments. Nice work!

elijahbenizzy · 2024-06-16T23:37:42Z

README.md


-# Hamilton
+With Hamilton, write a directed acyclic graph (DAG) of data transformations using regular Python functions. You don't even need to `import hamilton`! It uses the function name and parameters to resolve the graph. As shown below, functions specify their dependencies, resulting in readable code that can always be visualized.


Reiterate the tagline in the first sentence -- provides value

elijahbenizzy · 2024-06-16T23:38:53Z

README.md


-from hamilton import driver
+- **Low-friction dev to prod**. Use `@config.when()` to modify your DAG between execution environments instead of error-prone `if/else` feature flags. The notebook extension prevents the pain of migrating code from a notebook to a Python module.


Order is off -- put higher value ones first (effective collaboration + low-friction dev-to-prod)

I had it this way because it enabled me to link in order:

functions and nodes

Driver definition

function modifiers

Don't think ordered linking is important -- we want to order it by clear attainable value IMO

README.md

updated README

eb69f8a

zilto added the documentation Improvements or additions to documentation label Jun 14, 2024