docs: re-sync README CLI reference with current source#13
Open
sasmith wants to merge 2 commits into
Open
Conversation
Three small drifts in the rendered CLI reference. These fixes match what re-running the README generator (README.py) against current main would produce. - `cogames missions --game` and `cogames play --game` defaults: the rendered help still shows `cogs_vs_clips`. The current default is `cogsguard` (main.py:410, 655). - `cogames tutorial make-policy` summary: rendered help text was "Requires --trainable or --scripted." The current help text is "Requires exactly one policy type." (main.py:1017). - `cogames tutorial make-policy` Policy Type panel: the `--amongthem` flag (main.py:1043-1048) was missing from the rendered panel. The same edits are applied to README.md and the cached cell outputs in README.ipynb so they stay consistent under `cogames docsync check`. The Examples block (which uses `-t`/`-s` short flags) is intentionally left for a separate fix — that drift originates in the CLI epilog and is addressed in a separate PR; re-running the generator after both land will normalize everything. https://claude.ai/code/session_01LQ7Ac2JeU9EhGU2V4LyGf7
relh
pushed a commit
that referenced
this pull request
May 5, 2026
## Summary Port of [#13](#13) into the monorepo. Three drifts in the rendered CLI reference in `README.md` (and cached cell outputs in `README.ipynb`): - `cogames missions --game` and `cogames play --game` defaults: rendered help still showed `cogs_vs_clips`. Current default in source is `cogsguard`. - `cogames tutorial make-policy` summary line: rendered help text read "Requires --trainable or --scripted." Source has been updated to "Requires exactly one policy type." - `cogames tutorial make-policy` Policy Type panel: the `--amongthem` flag was missing from the rendered panel. ## Test plan - [ ] Run `cogames docsync check` — expect it to pass for these three sections 🤖 Generated with [Claude Code](https://claude.ai/code)
relh
force-pushed
the
main
branch
4 times, most recently
from
20578ae to
80a3706
Compare
nishu-builder
pushed a commit
that referenced
this pull request
May 7, 2026
## Summary Port of [#13](#13) into the monorepo. Three drifts in the rendered CLI reference in `README.md` (and cached cell outputs in `README.ipynb`): - `cogames missions --game` and `cogames play --game` defaults: rendered help still showed `cogs_vs_clips`. Current default in source is `cogsguard`. - `cogames tutorial make-policy` summary line: rendered help text read "Requires --trainable or --scripted." Source has been updated to "Requires exactly one policy type." - `cogames tutorial make-policy` Policy Type panel: the `--amongthem` flag was missing from the rendered panel. ## Test plan - [ ] Run `cogames docsync check` — expect it to pass for these three sections 🤖 Generated with [Claude Code](https://claude.ai/code)
nishu-builder
force-pushed
the
main
branch
4 times, most recently
from
6c38c63 to
cbd926f
Compare
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
3 participants
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
Three drifts in the rendered CLI reference in
README.md(and the cached cell outputs inREADME.ipynb). Each fix matches what re-running the generator (README.py) against currentmainwould produce — these are stale because the README has not been regenerated since the underlying CLI changed.cogames missions --gameandcogames play --gamedefaults: the rendered help still showscogs_vs_clips. The current default in source iscogsguard(main.py:410,main.py:655).cogames tutorial make-policysummary line: rendered help text reads "Requires --trainable or --scripted." Source has been updated to "Requires exactly one policy type." (main.py:1017).cogames tutorial make-policyPolicy Type panel: the--amongthemflag (main.py:1043-1048) was missing from the rendered panel.Both
README.mdand the cached outputs inREADME.ipynbare updated to keep the two in sync (socogames docsync checkdoes not flag a mismatch).Notes
tutorial make-policysection still uses-t/-sshort flags. That drift originates in the CLI epilog and is fixed in cli: fix three stale help-text bugs #12 (cli: fix three stale help-text bugs); after both PRs land, regenerating the README will remove the last bit of inconsistency cleanly.cogames docsync all, but the package is not installable in my environment (no PyPI access). The edits are surgical and verified to match the rendered output for the corresponding source.Test plan
cogames docsync checkon a properly set-up dev env — expect it to pass for these three sections.https://claude.ai/code/session_01LQ7Ac2JeU9EhGU2V4LyGf7
Generated by Claude Code