-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
phase/BetaBeta scopeBeta scope
Description
Problem
XML documentation warnings are globally suppressed, so public APIs can ship without docs.
- Suppression in
Directory.Build.props:12(<NoWarn>...CS1591</NoWarn>).
Goal
Phase in documentation enforcement without blocking short‑term delivery.
Plan
- Phase 1: Turn CS1591 into warning for
Honua.Core(or selected public assemblies) and document new public APIs. - Phase 2: Expand to additional projects (Server/Postgres) once baseline docs are improved.
- Phase 3: Promote to error for public APIs.
Tasks
- Remove global CS1591 suppression.
- Add project‑level settings to scope enforcement per assembly.
- Document existing public APIs in
Honua.Coreas a baseline. - Update contributing docs to require XML docs for new public types/members.
Acceptance criteria
- CS1591 enforced for
Honua.Coreat minimum. - New public APIs require XML docs.
- Build remains green with documented public surfaces.
Metadata
Metadata
Assignees
Labels
phase/BetaBeta scopeBeta scope