Skip to content

Generated @unverified docs can't name a third-party encoding's cause #93

Closed as not planned

Description

@Kinflou
  • Both generators call unverified::cause with Encodings::default(), because GenerateRequest carries no encoding declarations. So for a namespaced framing without vectors, the generated doc for @unverified can't name that cause.
  • Pass the visible FrozenUnit::Encoding declarations, or the per-protocol given-up causes, in the request (protocol 0, early days), and use them in comline-rust and comline-typescript.
  • Refs Third-party encodings and handshakes give up guarantees silently core#147.

Activity

  1. added
    enhancementNew feature or request
    P3Eventually
    codegenCode generation
    extensibilityThird-party encodings and generators
    on Oct 31, 2026
  2. Kinflou commented on Nov 9, 2026

    @Kinflou
    MemberAuthor

    ComlineProject/docs#162 (tracked in ComlineProject/core#219 and ComlineProject/core#222) would fix this from the schema side. A keyed @unverified gives each given-up guarantee its own reason, frozen with its scope, and the vocabulary gives the generated docs each guarantee's title and description. Generated docs could then say which cause belongs to which guarantee, a third-party encoding's included.

  3. Kinflou commented on Nov 15, 2026

    @Kinflou
    MemberAuthor

    No longer applies. Neither generator calls unverified::cause any more: generation#136 (generation does not render causes itself), comline-rust#121 and comline-typescript#160 render the protocol's frozen guarantee set and per-guarantee reasons, with nothing recomputed from encodings (comline-rust unverified_doc in codegen/src/generator.rs). That is the schema-side fix described in the 2026-11-09 comment (core#219 / core#222). If generated docs should name a third-party encoding's cause as such, that is a new, narrower issue under core#222.

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

    P3EventuallycodegenCode generationenhancementNew feature or requestextensibilityThird-party encodings and generators

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions