[ste100-docs-and-cli-standardization] #01: Standardize CLI Command & Argument Help Strings #15

New issue

Closed

opened 2026-08-28 17:32:18 +03:00 by jalmari · 0 comments

jalmari commented

2026-08-28 17:32:18 +03:00

Owner

Feature: ste100-docs-and-cli-standardization | Source: .scratch/ste100-docs-and-cli-standardization/issues/01-cli-help-standardization.md

01: Standardize CLI Command & Argument Help Strings

What to build: Audit and rewrite all argparse descriptions and --help argument strings in src/mailsweep/cli.py according to Strict STE rules (imperative mood, active voice, ≤20 words per description, no semicolons, no soft phrasal verbs). Add unit tests in test_mailsweep.py verifying that all parser subcommands and flags have non-empty, well-formatted help strings.

Blocked by: None (can start immediately)

Status: closed

All subcommands (sweep, scan, plan, backup, clean, restore, unsubscribe, rules, audit, test) have concise imperative descriptions in build_parser().
All CLI arguments have imperative help text with no semicolons or phrasal verbs.
Unit tests added to test_mailsweep.py validating parser integrity and help string quality.
All tests pass cleanly (pwsh -c uv run mailsweep test).

**Feature**: `ste100-docs-and-cli-standardization` | **Source**: `.scratch/ste100-docs-and-cli-standardization/issues/01-cli-help-standardization.md` # 01: Standardize CLI Command & Argument Help Strings **What to build:** Audit and rewrite all `argparse` descriptions and `--help` argument strings in `src/mailsweep/cli.py` according to Strict STE rules (imperative mood, active voice, ≤20 words per description, no semicolons, no soft phrasal verbs). Add unit tests in `test_mailsweep.py` verifying that all parser subcommands and flags have non-empty, well-formatted help strings. **Blocked by:** None (can start immediately) **Status:** closed - [x] All subcommands (`sweep`, `scan`, `plan`, `backup`, `clean`, `restore`, `unsubscribe`, `rules`, `audit`, `test`) have concise imperative descriptions in `build_parser()`. - [x] All CLI arguments have imperative help text with no semicolons or phrasal verbs. - [x] Unit tests added to `test_mailsweep.py` validating parser integrity and help string quality. - [x] All tests pass cleanly (`pwsh -c uv run mailsweep test`).

jalmari added the

ready-for-agent

feature

labels

2026-08-28 17:32:18 +03:00

jalmari added a new dependency

2026-08-28 17:32:32 +03:00

#16 [ste100-docs-and-cli-standardization] #02: Reformat Primary User Documentation (README.md and FAQ.md)

jalmari added a new dependency

2026-08-28 17:32:32 +03:00

#17 [ste100-docs-and-cli-standardization] #03: Reformat Deep Documentation & Python API Guides

jalmari added a new dependency