Skip to content

docs: Document --checkpoint-repo flag [doc-updater] - #846

Merged
jwbron merged 2 commits into
mainfrom
egg/doc-update-checkpoint-repo-flag
Feb 21, 2026
Merged

docs: Document --checkpoint-repo flag [doc-updater]#846
jwbron merged 2 commits into
mainfrom
egg/doc-update-checkpoint-repo-flag

Conversation

@james-in-a-box

Copy link
Copy Markdown
Contributor

docs: Document --checkpoint-repo flag [doc-updater]

Update checkpoint access guide to document the --checkpoint-repo flag, which was recently fixed in #845 to work correctly in HTTP mode (sandbox environments).

The flag allows users to override auto-detection and query checkpoints from an external repository. While the flag was already defined in the CLI help text, it was not mentioned in the user-facing guide.

Changes:

  • Add "Global Options" section to checkpoint-access.md
  • Document --checkpoint-repo and --repo-path flags with usage guidance

Triggered by: #845

Authored-by: egg

@egg-reviewer egg-reviewer Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Documentation-only change, 7 lines added. Reviewed the full diff against the actual argparse definitions and the implementation in PR #845.

Verified:

  • --repo-path and --checkpoint-repo are defined as top-level arguments on the ArgumentParser (not per-subcommand), confirming the doc's claim that they apply to "all egg-checkpoint commands."
  • The descriptions are accurate and consistent with the argparse help text and the _get_checkpoint_repo_from_args / _resolve_checkpoint_repo implementation.
  • Placement of the "Global Options" section (between intro and "When to Use Checkpoints") is reasonable — it's visible early and precedes command-specific sections.

No issues found.

One minor suggestion (non-blocking): the --checkpoint-repo bullet is noticeably longer than --repo-path. Consider breaking it into a shorter first sentence and moving the usage guidance to a second sentence or sub-bullet to keep the list scannable:

- `--checkpoint-repo OWNER/REPO` — External checkpoint repository in `owner/repo` format. Overrides auto-detection from repository settings.
  Use this when querying checkpoints from a different repository than the current one.

This is purely cosmetic — the current version is fine.

— Authored by egg

@james-in-a-box

This comment has been minimized.

@james-in-a-box

This comment has been minimized.

@james-in-a-box james-in-a-box Bot left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. Applied the formatting suggestion — split the --checkpoint-repo bullet into a shorter first sentence with usage guidance on a continuation line. Pushed in 69795aa.

— Authored by egg

@james-in-a-box

This comment has been minimized.

@egg-reviewer egg-reviewer Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re-review of commit 69795aa (delta from 2f2b993).

Change: Single cosmetic fix — split the --checkpoint-repo bullet into a shorter first sentence with the usage guidance on a continuation line.

Previous feedback addressed: The formatting suggestion from the initial review was applied exactly as proposed.

Verified against implementation: Re-confirmed that --repo-path and --checkpoint-repo are defined as top-level ArgumentParser arguments in shared/egg_contracts/checkpoint_cli.py:1229-1236, consistent with the doc's claim that they apply to all egg-checkpoint commands. Descriptions remain accurate.

No issues found.

— Authored by egg

@james-in-a-box

This comment has been minimized.

@james-in-a-box

Copy link
Copy Markdown
Contributor Author
egg is addressing review feedback...

@james-in-a-box

Copy link
Copy Markdown
Contributor Author

egg feedback addressed. View run logs

4 previous review(s) hidden.

@jwbron
jwbron merged commit ea3020f into main Feb 21, 2026
16 checks passed
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.

1 participant