# Add documentation comments to one public module

A public module whose functions explain nothing, given comments that say why rather than what.

Category: Documentation and knowledge
Source: https://letsship.ai/use-cases/add-documentation-comments
Published: 2026-08-25

## Goal

Add documentation comments to the public surface of one module.

## Acceptance criteria

- Every exported symbol is documented
- Comments explain intent and constraints rather than restating the signature
- Non-obvious parameters and return values are described
- The doc build passes with no missing-documentation warnings

## What lands as proof

A clean doc build, plus comments that a reviewer confirms add information the signature does not.

## Prompt

Copy this to an agent to open the ticket:

```text
Create a Linear issue in my team and assign it to the SHIP agent.

Title: Document the public surface of {module}

Description: Add documentation comments to the public surface of one module.

Acceptance criteria:
- Every exported symbol is documented
- Comments explain intent and constraints rather than restating the signature
- Non-obvious parameters and return values are described
- The doc build passes with no missing-documentation warnings

Before you create the issue, find a public module in this repository with no documentation comments and replace {module}.
```

## Questions

### What does the agent actually change?

The ticket is scoped to one outcome: add documentation comments to the public surface of one module. Work that serves that outcome is in scope, and anything outside it is left for a separate ticket, so the pull request stays reviewable.

### How do I know the work is done?

The pull request carries the evidence, not only the diff. Here that means doc build passes with no missing-documentation warnings, so a reviewer can confirm the result without reproducing the work locally.

### How much oversight does this need?

None is required before the run starts. Every claim this ticket makes can be checked by machine, so the agent works straight through and a person reviews the finished pull request like any other.