Skip to content

Docs: add doctest for consistency #32

@moven0831

Description

@moven0831

Problem

  • Documentation examples break when noir-rs APIs change, creating poor developer experience (see fix: correct import in readme #31). Examples aren't tested against actual code.

Solution

Implement doctests to automatically validate all documentation examples stay current with the codebase.

Acceptance Criteria

  • Minimal working examples for all core noir-rs features, which should cover all modules in noir/src/backends/barretenberg/mod.rs
  • Ensure examples are copy-pastable and self-contained
  • Set up cargo test --doc in CI pipeline
  • All code blocks in docs have doctest annotations
  • All existing tests still pass
  • All new doctests pass consistently

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    Status

    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions