Skip to content

cli: document --checkpoint-subset in the --help_all reference #844

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
FileSystemGuy merged 2 commits into from
Aug 11, 2026
Merged

cli: document --checkpoint-subset in the --help_all reference #844

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5898384
test(cli): RED — --help_all must document --checkpoint-subset
FileSystemGuy Aug 11, 2026
f950b91
fix(cli): GREEN — document --checkpoint-subset in the --help_all refe…
FileSystemGuy Aug 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions mlpstorage_py/cli/help_formatter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,7 @@
--results-dir/-rd PATH
[storage positional: file | object]
Optional:
--checkpoint-subset (8B at 8 processes only; declares a Subset run)
--exec-type/-et {mpi,docker} (default: mpi)
--hosts/-s HOST... (default: 127.0.0.1)
--num-checkpoints-read/-ncr N (default: 10; closed allows 10 or 0)
Expand Down
11 changes: 11 additions & 0 deletions tests/unit/test_help_behavior.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,17 @@ def test_help_all_prints_synopsis(self, capsys):
out = capsys.readouterr().out
assert 'SYNOPSIS' in out

def test_help_all_documents_checkpoint_subset(self, capsys):
"""--checkpoint-subset (added with the parser in 828cc63, storage#841)
must appear in the curated reference — the page is hand-maintained,
not generated from argparse, so a parser-only change silently omits
the flag here."""
with patch('sys.argv', ['mlpstorage', '--help_all']):
with pytest.raises(SystemExit):
parse_arguments()
out = capsys.readouterr().out
assert '--checkpoint-subset' in out

def test_help_all_prints_kv_section(self, capsys):
with patch('sys.argv', ['mlpstorage', '--help_all']):
with pytest.raises(SystemExit):
Expand Down
Loading