Skip to content

docs: Add inline examples to public API documentation #17

@josedab

Description

@josedab

Description

Several public API functions in src/ modules are missing doc examples (/// # Examples blocks).

Task

  • Pick 3-5 public functions that lack examples
  • Add idiomatic /// # Examples blocks with rust,no_run code fences
  • Run cargo doc --open to verify rendering

Helpful Context

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions