#0063 Help and Documentation #144

Merged

fuzzy merged 1 commit from feature/0063-help-and-documentation into main

2026-07-06 06:59:54 +00:00

automation commented

2026-07-06 06:56:58 +00:00

Owner

Enhances the CLI --help output with comprehensive documentation.

Changes:

src/hottea/cli.py — added EPILOG with env vars, examples, troubleshooting
tests/test_cli.py — 3 new tests for epilog content

Help output now includes:

4 required environment variables with descriptions
4 example command invocations (dry-run, end-date, verbose, output)
6 troubleshooting tips for common issues

Run hottea --help to see the full output.

Closes: #0063, #0059, #0060, #0061, #0062

Enhances the CLI --help output with comprehensive documentation. **Changes:** - `src/hottea/cli.py` — added EPILOG with env vars, examples, troubleshooting - `tests/test_cli.py` — 3 new tests for epilog content **Help output now includes:** - 4 required environment variables with descriptions - 4 example command invocations (dry-run, end-date, verbose, output) - 6 troubleshooting tips for common issues Run `hottea --help` to see the full output. **Closes:** #0063, #0059, #0060, #0061, #0062

automation added 1 commit

2026-07-06 06:56:58 +00:00

docs(cli): enhance --help with examples, env vars, troubleshooting

CI / lint-and-test (pull_request) Successful in 1m33s

Details

53550cee9a

Add comprehensive epilog to argparse with:
- Environment variable reference (4 required vars)
- Example command invocations (dry-run, end-date, verbose)
- Troubleshooting tips for common issues

Closes #59, #60, #61, #62, #63

the.auditor reviewed

2026-07-06 06:59:42 +00:00

the.auditor left a comment

Audit Review — PR #144

Clean help documentation enhancement. All 4 issues (#0059-#0062) addressed. Epilog covers required env vars, 4 example invocations, and 6 troubleshooting tips. Uses RawDescriptionHelpFormatter for proper formatting. Tests verify all sections present.

No suggestions — clean PR.

Summary

Result: COMMENT — no issues found.

## Audit Review — PR #144 Clean help documentation enhancement. All 4 issues (#0059-#0062) addressed. Epilog covers required env vars, 4 example invocations, and 6 troubleshooting tips. Uses `RawDescriptionHelpFormatter` for proper formatting. Tests verify all sections present. No suggestions — clean PR. ## Summary **Result:** COMMENT — no issues found.

the.auditor approved these changes

2026-07-06 06:59:46 +00:00

the.auditor left a comment

APPROVED. Help docs complete and thorough. Merge when ready.

fuzzy merged commit 53550cee9a into main

2026-07-06 06:59:54 +00:00

fuzzy deleted branch feature/0063-help-and-documentation

2026-07-06 06:59:54 +00:00