docs: fix four user-facing text drifts#11
Open
sasmith wants to merge 2 commits into
Open
Conversation
Verified against current CLI source: - MAKING_A_COGAME.md: `cogames tutorial train --timesteps` → `--steps` (the flag is `--steps` in main.py:1220). - AMONGTHEM_POLICY.md: `cogames login` → `cogames auth login` (no top-level `login`; cli/auth.py:25). - AMONGTHEM_POLICY.md: clarify that `_choose_actions` returns an array; the parent `step_batch` writes it into `raw_actions` (policy/amongthem_policy_template.py:81-96). - 02_TRAIN.md / .py / .ipynb: replace nonexistent "Checkpoint saved to:" example log line with the actual "Final checkpoint:" message (train.py:404). https://claude.ai/code/session_01LQ7Ac2JeU9EhGU2V4LyGf7
relh
pushed a commit
that referenced
this pull request
May 4, 2026
…443) ## Summary Migrated from [#11](#11). Four small fixes to user-facing markdown after a documentation audit — each is a verified text drift between docs and the current CLI/code. - `making_a_cogame.md`: `cogames tutorial train --timesteps` → `--steps` (the flag is `--steps`) - `AMONGTHEM_POLICY.md`: `cogames login` → `cogames auth login` (no top-level `login` command) - `AMONGTHEM_POLICY.md`: clarify that `_choose_actions()` returns an `np.ndarray`; the parent `step_batch()` writes it into `raw_actions` - `02_TRAIN.md` / `.py` / `.ipynb`: replace nonexistent "Checkpoint saved to:" example log line with the actual "Final checkpoint:" message ## Test plan - [ ] Spot-check rendered markdown looks reasonable 🤖 Generated with [Claude Code](https://claude.com/claude-code)
relh
pushed a commit
to Metta-AI/mettagrid
that referenced
this pull request
May 5, 2026
…443) ## Summary Migrated from [Metta-AI/cogames#11](Metta-AI/cogames#11). Four small fixes to user-facing markdown after a documentation audit — each is a verified text drift between docs and the current CLI/code. - `making_a_cogame.md`: `cogames tutorial train --timesteps` → `--steps` (the flag is `--steps`) - `AMONGTHEM_POLICY.md`: `cogames login` → `cogames auth login` (no top-level `login` command) - `AMONGTHEM_POLICY.md`: clarify that `_choose_actions()` returns an `np.ndarray`; the parent `step_batch()` writes it into `raw_actions` - `02_TRAIN.md` / `.py` / `.ipynb`: replace nonexistent "Checkpoint saved to:" example log line with the actual "Final checkpoint:" message ## Test plan - [ ] Spot-check rendered markdown looks reasonable 🤖 Generated with [Claude Code](https://claude.com/claude-code)
20578ae to
80a3706
Compare
nishu-builder
pushed a commit
that referenced
this pull request
May 7, 2026
…443) ## Summary Migrated from [#11](#11). Four small fixes to user-facing markdown after a documentation audit — each is a verified text drift between docs and the current CLI/code. - `making_a_cogame.md`: `cogames tutorial train --timesteps` → `--steps` (the flag is `--steps`) - `AMONGTHEM_POLICY.md`: `cogames login` → `cogames auth login` (no top-level `login` command) - `AMONGTHEM_POLICY.md`: clarify that `_choose_actions()` returns an `np.ndarray`; the parent `step_batch()` writes it into `raw_actions` - `02_TRAIN.md` / `.py` / `.ipynb`: replace nonexistent "Checkpoint saved to:" example log line with the actual "Final checkpoint:" message ## Test plan - [ ] Spot-check rendered markdown looks reasonable 🤖 Generated with [Claude Code](https://claude.com/claude-code)
6c38c63 to
cbd926f
Compare
relh
pushed a commit
to Metta-AI/mettagrid
that referenced
this pull request
May 22, 2026
…443) ## Summary Migrated from [Metta-AI/cogames#11](Metta-AI/cogames#11). Four small fixes to user-facing markdown after a documentation audit — each is a verified text drift between docs and the current CLI/code. - `making_a_cogame.md`: `cogames tutorial train --timesteps` → `--steps` (the flag is `--steps`) - `AMONGTHEM_POLICY.md`: `cogames login` → `cogames auth login` (no top-level `login` command) - `AMONGTHEM_POLICY.md`: clarify that `_choose_actions()` returns an `np.ndarray`; the parent `step_batch()` writes it into `raw_actions` - `02_TRAIN.md` / `.py` / `.ipynb`: replace nonexistent "Checkpoint saved to:" example log line with the actual "Final checkpoint:" message ## Test plan - [ ] Spot-check rendered markdown looks reasonable 🤖 Generated with [Claude Code](https://claude.com/claude-code)
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
Four small fixes to user-facing markdown after a documentation audit. Each is a verified text drift between docs and the current CLI/code.
MAKING_A_COGAME.md:cogames tutorial train --timesteps→--steps(the flag is--stepspermain.py:1220).src/cogames/docs/AMONGTHEM_POLICY.md:cogames login→cogames auth login(no top-levellogincommand; lives atcli/auth.py:25).src/cogames/docs/AMONGTHEM_POLICY.md: clarify that_choose_actions()returns annp.ndarray; the parentstep_batch()is what writes it intoraw_actions(policy/amongthem_policy_template.py:81-96).tutorials/02_TRAIN.md/.py/.ipynb: replace the nonexistent "Checkpoint saved to:" example log line with the actual "Final checkpoint:" message (train.py:404). Step 2 of the same tutorial already uses the correct wording.Test plan
cogames docsync checkonce a venv withcogamesinstalled is available, to confirm02_TRAINstays three-way in sync (only the swapped string changed in the.ipynb)https://claude.ai/code/session_01LQ7Ac2JeU9EhGU2V4LyGf7
Generated by Claude Code