Subcategory: User-facing documentation
Score: 9 → 10
The README is otherwise strong — 283 lines across 13 sections including a per-function API reference. One gap: the "Project structure" section (README.md:246) does not mention the root-level demo.py, which is the most obvious entry point for a new user wanting to see the library run. It is also the only non-src file carrying a lint error (ANN201, see the annotation issue).
What to change
README.md:246 — add demo.py to the Project structure listing- Add a line to "Quick start" (
README.md:59) showing how to run it, e.g. uv run demo.py
done when
README.md lists demo.py in the project structure and documents how to run it; make fmt's README/make help sync hook stays green.
Evidence
ANN201 Missing return type annotation for public function `generate_ohlc`
--> demo.py:45:5
Surfaced by the Rhiza quality gates during the template bump to jebel-quant/rhiza@v1.2.2, which enabled the stricter ruff rule families (ANN, A, BLE, ARG) and TYPECHECKER=both. Gate status at time of filing: make fmt FAIL, make typecheck FAIL, make docs-coverage FAIL, test-layout FAIL; make deptry, make security, make test PASS (154 tests, 100% coverage).
Subcategory: User-facing documentation
Score: 9 → 10
The README is otherwise strong — 283 lines across 13 sections including a per-function API reference. One gap: the "Project structure" section (
README.md:246) does not mention the root-leveldemo.py, which is the most obvious entry point for a new user wanting to see the library run. It is also the only non-srcfile carrying a lint error (ANN201, see the annotation issue).What to change
README.md:246— adddemo.pyto the Project structure listingREADME.md:59) showing how to run it, e.g.uv run demo.pydone when
README.mdlistsdemo.pyin the project structure and documents how to run it;make fmt's README/make helpsync hook stays green.Evidence
Surfaced by the Rhiza quality gates during the template bump to
jebel-quant/rhiza@v1.2.2, which enabled the stricter ruff rule families (ANN, A, BLE, ARG) andTYPECHECKER=both. Gate status at time of filing:make fmtFAIL,make typecheckFAIL,make docs-coverageFAIL, test-layout FAIL;make deptry,make security,make testPASS (154 tests, 100% coverage).