Repository navigation
Comment & doc grammar/tone batched for Errors.fs #46
Description
Category: docs Severity: minor
Location: src/Arcp.Core/Errors.fs:6-102
What
Multiple doc blocks are duplicated (the taxonomy description appears twice; the exception description appears twice). Tooltips render the duplicates verbatim.
Evidence
/// Canonical ARCP error taxonomy (spec §12). Fifteen cases.
...
/// Canonical ARCP error taxonomy (spec §12). Fifteen DU cases —
/// every wire error code has exactly one DU arm.
...
/// Exception form for C# interop and for fatal paths in F# where
/// the spec-canonical surface is "throw with code". Carries the
/// underlying `ARCPError`.
/// Convenience alias for `ARCPError`. ...
type SdkError = ARCPError
/// Exception form of `ARCPError` for C# callers and for paths
/// where the spec-canonical surface is "throw with code".
type ArcpException(error: ARCPError, ?inner: exn) =Proposed fix
Collapse duplicate doc blocks so each public type and module carries exactly one cohesive description.
Acceptance criteria
- No public symbol in this file has two consecutive
///doc blocks.
Activity
docs: fix audit documentation issues (#28, #34-37, #46, #56-59, #72)
nficano commentedon Jun 12, 2026
Fixed in #122 (merged).