Repository navigation
docs(cli): make five help texts match the commands - #45
Merged
Merged
Conversation
The second stack admit example piped mmlsquota-json into --quota-json - and passed --live-jobs "$(squeue ... | paste -sd,)", so both were read before any lock. The --live-jobs-cmd help, sharding-admission.org and stack-shard.org all say that list can miss a job that reserved in between. The example now takes --lock, --quota-cmd and --live-jobs-cmd, and admits a job with stub commands for mmlsquota-json and squeue. The top-level help listed exit status 0, 1 and 2; stack admit also exits 78 when it refuses the job, as cli.org's table says. campaign --help showed only the campaign status example, and not campaign run. stack generation --help and the generation_lint module doc mapped 2023.06 and 2025.06 but not 2026.06, which the bundled table maps to 2026.1. stack batch --installed-modulerc said "Modulerc file", while load_modulerc also scans a module tree, as the pr-overlap and rebuild-set help say. Five tests in cli_ergonomics.rs check these against cli.org, the bundled table and every command that takes --installed-modulerc. They fail without the fix. cli.org's stack batch text names both forms.
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.
Five
--helptexts now match what the commands do, including thestack admitexample and exit status 78.stack admit. The secondstack admitexample reads the quota and the scheduler inside--lockwith--quota-cmdand--live-jobs-cmd, instead of expandingsqueuebefore the lock.campaign --helpshowscampaign run.stack generation --helpmaps 2026.06 to 2026.1.stack batch --installed-modulercsays it reads a module tree as well as a.modulerc.luafile.top_level_help_names_every_exit_status_the_reference_lists,stack_admit_help_examples_read_the_scheduler_inside_the_lock,campaign_help_shows_how_to_start_a_campaign,stack_generation_help_maps_every_bundled_eessi_versionandevery_installed_modulerc_help_says_a_module_tree_is_readcover those. The commit has a towncrier fragment. Main has no towncrier yet; #26 (fix/towncrier) adds it.