Skip to content

XML comments cite spec section '§5.1' which does not exist (spec has flat §5) #48

Description

@nficano

Category: docs Severity: minor
Location: src/Arcp.Core/Envelope/Envelope.cs:59-60

What

ARCP v1.1 §5 (Wire Format) has no subsection §5.1, yet the wire layer repeatedly cites '§5.1' — Envelope.cs:9 and :59, EnvelopeJsonConverter.cs:11/:104/:106, and Identifiers.cs:8. The correct citation is §5.

Evidence

    /// <summary>Unknown top-level envelope fields preserved verbatim per spec §5.1 ("MUST ignore
    /// unknown fields") so they round-trip without loss.</summary>

Proposed fix

Replace the §5.1 references with §5 across the Envelope/converter/identifier XML comments.

Acceptance criteria

  • No source comment cites a non-existent spec section; wire-format references point to §5.

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: documentation inaccuracysev/minorSeverity: minor

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions