Skip to content

Example functions for the root package #25

Description

@jbeda

pkg.go.dev shows zero runnable examples for a library that advertises embeddability (presentation review, finding 4; polish grilling 2026-08-09). Agreed scope: ExampleFormat (five-line happy path), ExampleNeedsFormat (CI-gate pattern), ExampleFormat_options (mode + width). Explicitly out of scope: Example_customSegmenter — a toy segmenter good enough to publish as the reference is real design work, and a bad example at the one subtle extension point does harm; revisit when a real alternative segmenter exists.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions