Repository navigation
Use REM for the first comment line of each batch script - #38
Merged
Merged
Conversation
cmd.exe has no '#' comment syntax, so the leading '#' line of up.bat, down.bat and create_environments.bat was run as a command named '#' and printed a "not recognized" error before the real work. The rest of each script already uses REM. Also document headless_run.py's exit status 2 for invalid arguments in its module docstring, matching the README and the code. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The test fails against the scripts as they were before the REM change and passes after it, and needs no Windows since it reads the scripts as text. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Member
Author
|
Self-review rubric (head
Observations outside the diff:
Summary: a small, contained fix with an empirically confirmed regression guard. No blocking findings. This review was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener). drafted by Claude on behalf of Daniel Stephenson |
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
up.bat,down.batandcreate_environments.batis changed from a#line to aREMline.cmd.exehas no#comment syntax, so each of these lines was being run as a command named#, printing a "not recognized as an internal or external command" error at the start of every run. Every other comment in the scripts already usesREM.tests/test_batch_scripts.pyis added as a regression guard: it reads the three scripts as text and fails if any line starts with#. It needs no Windows, and the README's test section mentions it.headless_run.pynow states the exit status2for invalid arguments, which the code (sys.exit(2)) and the README already describe; the docstring previously listed only0and1.The cycle was run as a documentation accuracy sweep (the open backlog being gated or large, see below). The README, the batch scripts and the CLI argument handling in
main.pyandheadless_run.pywere checked against source; apart from the items above, no drift was found.Closes #37
Test plan
python -m py_compileof every top-level module passespython3 -m unittest discover -s tests— 123 tests ran, OK (Python 3.8.10, pygame 2.1.2)git checkout origin/main -- *.bat) and failed for all three, then passed with the fix restoredpython3 headless_run.py— all three scenarios PASSpython3 headless_run.py xexits with status 2, matching the updated docstringcmd.exeis available in the environment the change was made in; the fix rests onREMbeing the documentedcmd.execomment command and on the scripts' existingREMlines. Runningup.batonce on Windows and confirming no'#' is not recognizedline appears would verify it.Deferred issues
This PR description was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).
🤖 Generated with Claude Code
drafted by Claude on behalf of Daniel Stephenson