docs: correct README setup, run, and feature claims - #12
Merged
Conversation
The Setup section pointed at a repository URL and directory name that no longer exist (dmccoystephenson/testing-drawing-grid) and referenced a requirements.txt that is not in the tree. The Running section referenced a run.sh script that does not exist, and neither the Viron submodule nor the CLI arguments accepted by main.py were documented anywhere. - Point Setup at Preponderous-Software/patchwork and document the Viron submodule, which main.py imports from at runtime - Drop the run.sh and requirements.txt instructions - Document the gridSize and --exit-after-create arguments, including the positional constraint and the environments.json cache behavior - Document up.bat, down.bat, and create_environments.bat, plus the cross-platform docker compose equivalents - Move "Interactive toggling of cell states" from Features to Roadmap; the render loop only handles pygame.QUIT and drawButton is never called Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Member
Author
|
Self-review rubric (documentation accuracy sweep):
One rubric item was fixed during review rather than deferred:
Two observations are folded into this body rather than left inline, since they fall outside the diff hunks:
This PR comment was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
A repo-wide documentation accuracy sweep was performed against the actual source. Every claim in
README.mdwas checked againstmain.py,graphik.py,.gitmodules, and the three.batscripts. Only documentation was changed; no code was touched.Drift that was found and corrected:
git clone https://github.com/dmccoystephenson/testing-drawing-grid.git/cd testing-drawing-gridwas replaced withPreponderous-Software/patchwork.Vironsubmodule was undocumented.main.pyimportsEnvironmentServiceandLocationServicefromViron/, so a clone without--recurse-submodulescannot run. Both the recursive-clone and the after-the-factgit submodule update --init --recursiveforms are now documented.pip install -r requirements.txtwas referenced. Norequirements.txtis present in the tree;pip install pygameis documented instead.bash run.shwas referenced. Norun.shis present in the tree; that instruction was removed.50, with a50fallback on an unparseable value) and--exit-after-createare now described, including the fact that the flag is read positionally fromsys.argv[2]and therefore requires a grid size before it, and that it has no effect when the requested key is already cached.environments.jsoncache was undocumented. Its key format (<numGrids>x<gridSize>, with the grid count currently fixed at1) and its re-load-instead-of-re-create behavior are now described..batscripts were undocumented.up.bat,down.bat, andcreate_environments.batare now described alongside the equivalentdocker compose -f Viron/compose.yml ...commands for non-Windows platforms, together with thehttp://localhost:9999expectation.main.pyhandles onlypygame.QUIT, andGraphik.drawButtonis defined but never called anywhere. The item was moved from Features to Roadmap.No tracking issue — the drift was found during triage.
Test plan
python3 -m py_compile main.py graphik.py __init__.pypasses.run.shandrequirements.txtwas confirmed by listing the tree.main.pyandgraphik.pyforMOUSE,KEYDOWN,drawButton, andevent.type; the only hit inmain.pyisevent.type == pygame.QUIT.main.pylines 21-38 and 96-103..batbehavior was read out ofup.bat,down.bat, andcreate_environments.bat.Viron/compose.ymlwas confirmed to exist at the path used in the documented commands.Deferred issues
The remaining open backlog was not picked up this cycle. Skip reasons are recorded here for auditability:
RenderWindowclass to manage Pygame initialization #6 (RenderWindowclass) — already implemented by open draft PR Add RenderWindow class for Pygame window management #10, which is human-gated (see below).numGridsis currently hardcoded to1inmain.pyand the change requires a live Viron server for validation.Note on PR #10
Draft PR #10 remains open and blocked on two maintainer-only actions: it is still marked Draft (
gh pr readyis not permitted in this run's tooling), and it carries a staleCHANGES_REQUESTEDreview that was left before the concern was addressed. No third status comment was added there, since two already exist. This PR was kept documentation-only and itsREADME.mdedits sit outside the section PR #10 adds, so the two are expected to merge without conflict.This PR description was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).