Skip to content

Errors.fs SdkError carries a doc block describing the exception #36

Description

@nficano

Category: docs Severity: minor
Location: src/Arcp.Core/Errors.fs:92-102

What

Lines 92-94 describe ArcpException but sit above SdkError. The exception-form description is then repeated correctly at lines 100-101. The misplaced doc will surface in tooltips for SdkError.

Evidence

/// 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`. The protocol uses "ARCP"
/// all-caps, so the spec-named type is `ARCPError`; `SdkError`
/// is the F#-conventional name for callers who prefer it.
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

Delete the stray doc block at lines 92-94 (the alias doc at 95-97 is the correct one) and keep the doc at lines 100-101 on ArcpException.

Acceptance criteria

  • IDE tooltip for SdkError shows only the alias description; ArcpException shows only the exception description.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    audit/docsAudit finding — documentationsev/minorSeverity — minor

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions