---
id: TASK-4
title: Document public CLI and error types
status: Done
assignee:
  - codex
created_date: '2026-02-24 09:46'
updated_date: '2026-02-24 09:49'
labels: []
dependencies: []
references:
  - src/core/cli.rs
  - src/core/cmd.rs
documentation:
  - docs/spec.md
  - docs/plan.md
---

## Description

<!-- SECTION:DESCRIPTION:BEGIN -->
Add Rust doc comments for currently undocumented public items so API documentation is complete and consistent with existing project style.
<!-- SECTION:DESCRIPTION:END -->

## Acceptance Criteria
<!-- AC:BEGIN -->
- [x] #1 `src/core/cli.rs` has a doc comment for the public `Cli` struct consistent with existing doc style.
- [x] #2 `src/core/cmd.rs` has a doc comment for the public `KazeError` enum consistent with existing doc style.
- [x] #3 `just check` runs without any missing-doc related warnings.
- [x] #4 `src/core/cmd.rs` documents all `KazeError` variants.
- [x] #5 `src/core/exec.rs` documents the `ExecError::Failed` fields (`cmd`, `status`).
- [x] #6 `src/core/config.rs` documents the `ConfigError::NotFound` field (`start`).
- [x] #7 `src/config/load.rs` documents the `LoadError` variant fields (`path`, `source`).
<!-- AC:END -->

## Implementation Plan

<!-- SECTION:PLAN:BEGIN -->
1. Review existing doc style in src/core/cli.rs, src/core/cmd.rs, src/core/exec.rs, src/core/config.rs, and src/config/load.rs to mirror tone and sections.
2. Add doc comments for `Cli` and `KazeError` (enum + variants) in their respective modules.
3. Add doc comments for missing fields in `ExecError::Failed`, `ConfigError::NotFound`, and `LoadError` variants.
4. Run `just check` to confirm no missing-doc warnings and acceptance criteria met.
<!-- SECTION:PLAN:END -->

## Implementation Notes

<!-- SECTION:NOTES:BEGIN -->
Added docs for KazeError variants, ExecError::Failed fields, ConfigError::NotFound field, and LoadError fields. `just check` is clean.
<!-- SECTION:NOTES:END -->

## Final Summary

<!-- SECTION:FINAL_SUMMARY:BEGIN -->
Documented missing public API items and variant/field docs across core errors and load/config modules. Tests: `just check`.
<!-- SECTION:FINAL_SUMMARY:END -->
