cli: fix three stale help-text bugs#12
Open
sasmith wants to merge 2 commits into
Open
Conversation
- tutorial make-policy: epilog showed `-t`/`-s` short flags that aren't defined on the typer Options. Switched to the canonical long forms --trainable/--scripted (the runtime error message at line 1070 also uses long forms). - cogames docs: argument help listed 'evals, mapgen' (not registered) and omitted 'amongthem_policy'. Build the list dynamically from _DOC_DESCRIPTIONS so it stays consistent with the registered set. - cogames missions: the metadata fast-path used metavar='MISSION' for the positional argument; the full command uses metavar='FILTER'. Changed the fast path to 'FILTER' so users see a consistent label (and 'FILTER' more accurately describes a substring filter). https://claude.ai/code/session_01LQ7Ac2JeU9EhGU2V4LyGf7
1 task
relh
pushed a commit
that referenced
this pull request
May 5, 2026
## Summary Port of [#12](#12) into the monorepo (minus the missions metavar fix, since that command was removed in #12430). - **`tutorial make-policy` epilog**: advertised `-t`/`-s` short flags that aren't defined on the typer Options — copy-pasting the example commands would fail. Switched to canonical `--trainable`/`--scripted` long forms. - **`cogames docs` argument help**: listed `evals` and `mapgen` (not registered, would fail with "Unknown document") and omitted `amongthem_policy`. Now built dynamically from `_DOC_DESCRIPTIONS` so it can't drift again. ## Test plan - [x] `uv run python -c "import cogames.main"` parses cleanly - [ ] `cogames tutorial make-policy --help` example block uses long flags - [ ] `cogames docs --help` lists all currently-registered doc names 🤖 Generated with [Claude Code](https://claude.ai/code)
20578ae to
80a3706
Compare
nishu-builder
pushed a commit
that referenced
this pull request
May 7, 2026
## Summary Port of [#12](#12) into the monorepo (minus the missions metavar fix, since that command was removed in #12430). - **`tutorial make-policy` epilog**: advertised `-t`/`-s` short flags that aren't defined on the typer Options — copy-pasting the example commands would fail. Switched to canonical `--trainable`/`--scripted` long forms. - **`cogames docs` argument help**: listed `evals` and `mapgen` (not registered, would fail with "Unknown document") and omitted `amongthem_policy`. Now built dynamically from `_DOC_DESCRIPTIONS` so it can't drift again. ## Test plan - [x] `uv run python -c "import cogames.main"` parses cleanly - [ ] `cogames tutorial make-policy --help` example block uses long flags - [ ] `cogames docs --help` lists all currently-registered doc names 🤖 Generated with [Claude Code](https://claude.ai/code)
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
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 small fixes to user-facing CLI help/argument metadata after a documentation audit.
tutorial make-policyepilog advertised-t/-sshort flags that are not defined on the typerOptions — the example commands fail if copy-pasted. Switched the epilog to the canonical long forms--trainable/--scripted(the runtime error message at line 1070 already uses long forms).cogames docsargument help listedevalsandmapgen(not registered, would fail with "Unknown document") and omittedamongthem_policy. The list is now built dynamically from_DOC_DESCRIPTIONSso it can't drift again.cogames missionsargument metavar was inconsistent — the metadata-only fast-path declaredmetavar="MISSION"while the full command declaredmetavar="FILTER". Users saw two different labels for the same parameter;FILTERis also the more accurate description (it's a substring filter, not a mission name). Fast-path aligned with the full command.Test plan
python -c "import cogames.main"parses (verified locally)cogames docs --helplists all currently-registered doc namescogames docs evalsno longer appears as a valid option in helpcogames tutorial make-policy --helpexample block uses long flagshttps://claude.ai/code/session_01LQ7Ac2JeU9EhGU2V4LyGf7
Generated by Claude Code