Require doc comments on the wire contract and the ports

Open
#747 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
62/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
rust

Research direction

Start at the crates/api crate root and the ports module in crates/app/src/ports, where the #![warn(missing_docs)] attribute goes. Add the lint, then run cargo build (or cargo doc) on those two targets and work through the warnings item by item, reading each item's signature and call sites for its meaning. Done when the two targets build with no missing_docs warnings and the doc comments state contract and port intent, not just restated names.

Written by the indexing model from the issue text.

Description

documentation priority: low

About 95% of public items in crates/api and 92% in crates/app/src/ports have doc comments (a rough count; domain and app are near 80%). No lint enforces it. Turning on missing_docs across the workspace would flag 1,186 items, because it also counts fields and variants.

Change: #![warn(missing_docs)] in api and on the ports module only, and document what it flags.

Found by the technical debt audit of 15c440ab6 (2026-11-15).

Dominant language
Rust
Stars
0
Forks
0
Avg merge
56m
Merged PRs (30d)
349

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from nledford/Ladderback

All issues in nledford/Ladderback

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.