Skip to content

Add more Rustdoc examples for public library APIs #15

@inxbit

Description

@inxbit

PrismTTY exposes a small public Rust API for configuration parsing, profile stores, styles, batch highlighting, and streaming highlighting.

A first pass of examples should cover the most common entry points. Follow-up examples would still be useful for:

  • ProfileStore::builtin and PrismConfig::from_profiles
  • Highlighter::style_spans
  • ColorMode and ANSI16 output
  • Style parsing and palette usage
  • Benchmark collection with StreamingHighlighter

Examples should compile as doctests and use synthetic documentation-only input.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions