Skip to content

cli: fix three stale help-text bugs#12

Open
sasmith wants to merge 2 commits into
mainfrom
claude/cli-fix-stale-help-text
Open

cli: fix three stale help-text bugs#12
sasmith wants to merge 2 commits into
mainfrom
claude/cli-fix-stale-help-text

Conversation

@sasmith
Copy link
Copy Markdown
Contributor

@sasmith sasmith commented May 2, 2026

Summary

Three small fixes to user-facing CLI help/argument metadata after a documentation audit.

  • tutorial make-policy epilog advertised -t / -s short flags that are not defined on the typer Options — 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 docs argument help listed evals and mapgen (not registered, would fail with "Unknown document") and omitted amongthem_policy. The list is now built dynamically from _DOC_DESCRIPTIONS so it can't drift again.
  • cogames missions argument metavar was inconsistent — the metadata-only fast-path declared metavar="MISSION" while the full command declared metavar="FILTER". Users saw two different labels for the same parameter; FILTER is 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 --help lists all currently-registered doc names
  • cogames docs evals no longer appears as a valid option in help
  • cogames tutorial make-policy --help example block uses long flags

https://claude.ai/code/session_01LQ7Ac2JeU9EhGU2V4LyGf7


Generated by Claude Code

nishu-builder and others added 2 commits April 28, 2026 11:33
- 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
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)
@relh relh force-pushed the main branch 4 times, most recently from 20578ae to 80a3706 Compare May 5, 2026 21:34
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)
@nishu-builder nishu-builder force-pushed the main branch 4 times, most recently from 6c38c63 to cbd926f Compare May 12, 2026 22:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants