docs only
Details
Details
- Reviewers
max - Group Reviewers
Restricted Project - Commits
- R1:f7cb9b801b45: Rewrote airline demo readme
Diff Detail
Diff Detail
- Repository
- R1 dagster
- Branch
- airline_readme
- Lint
No Linters Available - Unit
No Unit Test Coverage
Event Timeline
Comment Actions
yeah agree re: amount of code - but arguably true for the exposition, YAML, UI screenshots, etc. also.
Maybe best bet would be to reduce the surface area of this README? it covers a _ton_ of ground for one document...
| examples/dagster_examples/airline_demo/README.md | ||
|---|---|---|
| 74 | must've been some non-printing unicode character, it appears as a space in my editor - seems to be fixable | |
| 156–159 | fixed | |
| 422–423 | sg! | |
Comment Actions
spitting out ideas:
- just cite where the code is instead of inlining it "you can see this in fn_name in file.py"
- move the content in to comment blocks - maybe tag them and then refer to those tags in this readme
Comment Actions
I'd prefer to move this to docs/.rst and build the code in through the Sphinx build process -- then link to the docs from a very short README,md in the demo directory.