fix(cli): OS-aware help for installed users (#1130)#1132
Draft
FabioLeitao wants to merge 6 commits into
Draft
Conversation
Extract cli_presentation (prog detection, Path.home() examples, epilog template). main.py uses dynamic prog and argparse %(prog)s substitution.
…1130) Wire cli_help_context into help_page; template uses literal data-boar and Path.home()-based filesystem example instead of ~ or dev python main.py.
dashBOARd help intro copy targets pipx/PATH installs; sync catalog source strings in build_locale_catalogs.py.
Add test_cli_presentation; clarify operator_help_sync manifest that dev uv flows belong in repo docs, not installed-user surfaces.
SYNOPSIS and EXAMPLES in data_boar.1 plus api/TLS notes in data_boar.5 show the installed command (man data-boar), not python main.py.
…1131) Fail if docs/data_boar.1 or data_boar.5 contain uv run or python main.py in installed-user troff sources; dev modalities stay in repo docs only.
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
1 participant
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.
Summary
Closes #1130 (help OS-aware steering v2).
Installed-user surfaces (
data-boar --help, dashBOARd/help):%(prog)s(data-boarwhen installed,python main.pyin dev)./helpshows onlydata-boarin command examples; filesystem paths use concretePath.home()(no~).run_cli_p1targets PATH/pipx installs — nouv run/python main.py.Repo docs (README / CONTRIBUTING / QUICKSTART): unchanged — still document all dev modalities on purpose.
Commits (split-by-subject)
fix(cli)—utils/cli_presentation.py+main.pyfix(api)—help.html+routes.pyfix(api)— locales +build_locale_catalogs.pysourcetest(cli)—test_cli_presentation.py+ manifest noteTest plan
./scripts/check-all.shgreen locallypytest tests/test_cli_presentation.py tests/test_operator_help_sync.py— 12/12Follow-up (same PR, after audit — separate prompt)
docs/data_boar.1,data_boar.5, anti-drift guard) — not in this slice yet.Made with Cursor