docs: document runtime global and deploy flags - #74
Conversation
|
👋 Hi @tasodoufu — thank you so much for your first contribution to HFlow! A maintainer will review your pull request as soon as possible. In the meantime:
💡 Tip: one open pull request per contributor at a time. Issues with an assignee are taken; everything else is fair game. We are excited to have you here and appreciate your help making the project better! 🙌 |
kstonekuan
left a comment
There was a problem hiding this comment.
Thank you @tasodoufu, and welcome! Clean first contribution: the wording matches the actual --help text, the placement is sensible, and the --requirements cross-reference to hflow up is exactly right.
What I validated locally:
- Ran the full lychee link check from CONTRIBUTING.md on your branch (you noted it was unavailable in your environment): 230 links, 0 errors.
- Verified the "must appear before the subcommand" claim against the real CLI:
hflow -v statusparses,hflow status -vexits 2. Nice catch documenting that; it is exactly the kind of detail argparse makes non-obvious. - Checked both
deployflag descriptions againstsrc/hflow/cli.py; both match.
Merging now. If you would like another one, the open good first issues have plenty left (issues with an assignee are taken; everything else is fair game), and we hang out on Discord.
Summary
Document the global
hflowflags and thedeployoptions that were recently added to the CLI reference.Why
Resolves #72. Users can now find
--version,-v/--verbose,deploy --output-dir, anddeploy --requirementsindocs/RUNTIME.md, with wording aligned to the current CLI help and behavior.User impact
The runtime reference is more complete and no product behavior changes.
Validation
uv run python - <<'PY' ...(asserted all four option names are documented)git diff --checklycheeis not installed in the environment.Unverified
The full
lycheecommand from CONTRIBUTING.md was not run because the tool is unavailable locally.