Skip to content

Fix #2035: add missing doc comments to 16 crates (doc gaps 2026-06-03)#896

Open
AlexMikhalev wants to merge 11 commits into
mainfrom
task/2035-doc-gaps-20260603
Open

Fix #2035: add missing doc comments to 16 crates (doc gaps 2026-06-03)#896
AlexMikhalev wants to merge 11 commits into
mainfrom
task/2035-doc-gaps-20260603

Conversation

@AlexMikhalev
Copy link
Copy Markdown
Contributor

@AlexMikhalev AlexMikhalev commented Jun 3, 2026

Summary

Adds missing item-level `///` doc comments to eliminate all `RUSTDOCFLAGS="-W missing-docs"` warnings across all 18 crates listed in issue #2035.

Result: 0 warnings across all 18 crates

Crate Warnings before Warnings after
terraphim_types 1 0
haystack_jmap 1 0
haystack_core 3 0
terraphim_settings 4 0
terraphim_mcp_server 6 0
terraphim_rolegraph 11 0
terraphim_sessions 12 0
terraphim_persistence 19 0
terraphim_middleware 35 0
terraphim_config 43 0
terraphim_automata 80 0
terraphim_rlm 83 0
terraphim_grep 125 0
terraphim_service 111 0
terraphim_agent 119 0
terraphim_orchestrator 674 0
haystack_atlassian 0 0
haystack_discourse 0 0

Approach

  • Enum variant docs: one sentence describing what the variant represents
  • Struct field docs: one sentence describing what the field holds
  • Module docs: brief description of the module's purpose
  • Function/method docs: one sentence describing what the function does
  • No logic or signature changes — doc comments only
  • One macro-generated item in `terraphim_settings` (`twelf::config`) suppressed with `#![allow(missing_docs)]` and a comment explaining why

Verification

```bash
RUSTDOCFLAGS="-W missing-docs" cargo doc --no-deps -p 2>&1 | grep "^warning: missing"

Returns empty for all 18 crates

```

Fixes #2035 (Gitea)

🤖 Generated with Terraphim AI

Test User and others added 11 commits June 3, 2026 18:16
…re, jmap, settings, mcp_server, rolegraph, sessions, persistence, middleware) Refs #2035
Add /// doc comments to all public items in terraphim_service that were
flagged by RUSTDOCFLAGS="-W missing-docs": modules, enum variants, struct
fields, trait methods, type aliases, and builder methods. Zero warnings
remain after this change.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…Refs #2035

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…oller Refs #2035

Co-Authored-By: Terraphim AI <noreply@terraphim.ai>
…n, quickwit, pr_review, provider_probe, and more) Refs #2035
…ngs; all 18 crates at 0 warnings Refs #2035
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