Skip to content

docs: fix four user-facing text drifts#11

Open
sasmith wants to merge 2 commits into
mainfrom
claude/docs-fix-md-text-drift
Open

docs: fix four user-facing text drifts#11
sasmith wants to merge 2 commits into
mainfrom
claude/docs-fix-md-text-drift

Conversation

@sasmith
Copy link
Copy Markdown
Contributor

@sasmith sasmith commented May 2, 2026

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 --steps per main.py:1220).
  • src/cogames/docs/AMONGTHEM_POLICY.md: cogames logincogames auth login (no top-level login command; lives at cli/auth.py:25).
  • src/cogames/docs/AMONGTHEM_POLICY.md: clarify that _choose_actions() returns an np.ndarray; the parent step_batch() is what writes it into raw_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

  • Spot check rendered markdown looks reasonable
  • Optionally run cogames docsync check once a venv with cogames installed is available, to confirm 02_TRAIN stays three-way in sync (only the swapped string changed in the .ipynb)

https://claude.ai/code/session_01LQ7Ac2JeU9EhGU2V4LyGf7


Generated by Claude Code

nishu-builder and others added 2 commits April 28, 2026 11:33
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)
@relh relh force-pushed the main branch 3 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
…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)
@nishu-builder nishu-builder force-pushed the main branch 4 times, most recently from 6c38c63 to cbd926f Compare May 12, 2026 22:38
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)
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