Skip to content

Add @example JSDoc tags to coherence scoring functions #9

Description

@josedab

What

The coherenceScore() and bpmFromHz() functions in packages/core/src/coherence.ts have JSDoc but could benefit from more complete @example blocks showing real-world usage.

Where

  • packages/core/src/coherence.ts

How

  1. Look at existing @example patterns in packages/core/src/hrv.ts for reference
  2. Add a practical example showing how to use coherence scoring with RR intervals from a session
  3. Run pnpm test && pnpm lint to verify

Acceptance Criteria

  • Both functions have @example with runnable TypeScript
  • pnpm test && pnpm lint pass

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