Skip to content

Add Rustdoc Coverage and Enforce Missing Docs#41

Merged
brdv merged 1 commit intomainfrom
document-rustdoc-coverage
Mar 11, 2026
Merged

Add Rustdoc Coverage and Enforce Missing Docs#41
brdv merged 1 commit intomainfrom
document-rustdoc-coverage

Conversation

@brdv
Copy link
Owner

@brdv brdv commented Mar 11, 2026

Summary

Add crate, module, and public API Rustdoc across the stck implementation and enable a missing-docs lint at the crate root.

This documents the stack planning, subprocess, and resumable-state contracts now that the module layout has stabilized, and keeps future public surface changes honest by having the compiler enforce documentation coverage.

Changelist

  • src/lib.rs adds crate-level Rustdoc and enables missing_docs
  • src/main.rs, src/cli.rs, src/commands.rs, src/env.rs, and src/util.rs now document their module responsibilities
  • src/github.rs, src/gitops.rs, src/stack.rs, and src/sync_state.rs now document the key public types, fields, and helper contracts

Stack parent: none
Stack child: none yet

Checklist

  • Changes are minimal and focused for this milestone
  • No breaking CLI changes unless explicitly intended
  • Errors are user-facing, actionable, and prefixed with error:
  • Added/updated tests for behavior changes
  • Updated docs/plan if behavior or scope changed

@brdv brdv changed the title document-rustdoc-coverage Add Rustdoc Coverage and Enforce Missing Docs Mar 11, 2026
@brdv brdv merged commit ed503fb into main Mar 11, 2026
1 check passed
@brdv brdv deleted the document-rustdoc-coverage branch March 11, 2026 12:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant