Skip to content

Comment & doc grammar/tone batched for Errors.fs #46

@nficano

Description

@nficano

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    audit/docsAudit finding — documentationsev/minorSeverity — minor

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions