-
-
Notifications
You must be signed in to change notification settings - Fork 5
README claims 'no tests' but the indexer has 7 #3
Copy link
Copy link
Open
Labels
acceptedWe want this and it is free to take - comment 'claiming this'We want this and it is free to take - comment 'claiming this'documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueaccepted + small and self-contained - start hereaccepted + small and self-contained - start here
Description
Activity
Metadata
Metadata
Assignees
Labels
acceptedWe want this and it is free to take - comment 'claiming this'We want this and it is free to take - comment 'claiming this'documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueaccepted + small and self-contained - start hereaccepted + small and self-contained - start here
The README says the project "has no tests" in two places, but
tests/test_index_notes.pyexists and contains 7 tests (added when #2 was closed). So the claim is stale in the direction that matters: a reader deciding whether to trust or contribute sees "no tests" and stops.Two spots to fix:
README.md:11— "it is deliberately minimal, has no tests, and makes no attempt to be general"README.md:86— "No incremental indexing, no eval suite, no packaging, and no tests"README.md:150also points at #2 as an open gap; #2 is closed.What "done" looks like
Replace both claims with what is actually true today:
index_notes.pyhas 7 tests,brain_ask.pyandturnstate_hook.pyhave none. Keeping the honest half of the sentence matters more than making the project sound finished — the point is that a reader can tell which module is covered and which is not.Why this is a good first issue
You need to read the repo to answer it correctly, but you do not need to run the model stack or have an Obsidian vault. Run
python -m pytest tests/ -qand count what you see.Comment "claiming this" and it is yours.