docs: Document --checkpoint-repo flag [doc-updater] - #846
Conversation
There was a problem hiding this comment.
Documentation-only change, 7 lines added. Reviewed the full diff against the actual argparse definitions and the implementation in PR #845.
Verified:
--repo-pathand--checkpoint-repoare defined as top-level arguments on theArgumentParser(not per-subcommand), confirming the doc's claim that they apply to "allegg-checkpointcommands."- The descriptions are accurate and consistent with the argparse help text and the
_get_checkpoint_repo_from_args/_resolve_checkpoint_repoimplementation. - 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
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
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
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
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
This comment has been minimized.
This comment has been minimized.
| egg is addressing review feedback... |
|
egg feedback addressed. View run logs 4 previous review(s) hidden. |
docs: Document --checkpoint-repo flag [doc-updater]
Update checkpoint access guide to document the
--checkpoint-repoflag, 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:
--checkpoint-repoand--repo-pathflags with usage guidanceTriggered by: #845
Authored-by: egg