Problem
Two small but user-facing problems in README.md:
1. The quickstart snippet doesn't run as written.
The code block in section 2. Quickstart (README.md, lines ~48–72) starts with only:
from h5i.orchestra import Conductor
but then uses asyncio.gather(...) and asyncio.run(main(...)). Copy-pasting it into ensemble.py and running python ensemble.py — exactly what the README tells you to do — fails immediately with:
NameError: name 'asyncio' is not defined
This is the very first code a new user runs, so it's worth getting right.
2. The tutorial list in section 3. Examples is out of sync with examples/tutorial/.
The directory contains 9 scripts, but the README lists only 7:
pipeline_score.py is missing from the list.
quorum_ensemble.py is missing from the list.
- The entry for
debate_then_build.py says "architect-to-implementer pipelines" — but that's actually what pipeline_score.py does (see its docstring: "architect designs, implementer builds, hardener tests"). debate_then_build.py is about settling a design question via debate before building.
Suggested fix
Docs-only change, no code knowledge required beyond reading the example docstrings. A great first contribution.
Problem
Two small but user-facing problems in
README.md:1. The quickstart snippet doesn't run as written.
The code block in section 2. Quickstart (README.md, lines ~48–72) starts with only:
but then uses
asyncio.gather(...)andasyncio.run(main(...)). Copy-pasting it intoensemble.pyand runningpython ensemble.py— exactly what the README tells you to do — fails immediately with:This is the very first code a new user runs, so it's worth getting right.
2. The tutorial list in section 3. Examples is out of sync with
examples/tutorial/.The directory contains 9 scripts, but the README lists only 7:
pipeline_score.pyis missing from the list.quorum_ensemble.pyis missing from the list.debate_then_build.pysays "architect-to-implementer pipelines" — but that's actually whatpipeline_score.pydoes (see its docstring: "architect designs, implementer builds, hardener tests").debate_then_build.pyis about settling a design question via debate before building.Suggested fix
import asyncioto the quickstart code block.pipeline_score.pyandquorum_ensemble.pyto the section-3 list, with one-line descriptions taken from their header docstrings.debate_then_build.pydescription (debate to settle a design question, then build).examples/README.mdalso omitsquorum_ensemble.pyfrom its run list and tables — add it there too.Docs-only change, no code knowledge required beyond reading the example docstrings. A great first contribution.