Skip to content

enhancement: add complete JSDoc comments to all SDK functions #26

Description

@devmocrea

Description

To improve third-party developer adoption, document all exported functions in the SDK using comprehensive TypeScript JSDoc comments.

Technical Specification

  • Add structured JSDoc headers to:
    • callCreateCircle
    • callContribute
    • callTriggerPayout
  • Document all parameters, return parameters, and thrown errors.

Acceptance Criteria

  • Developers see rich, structured tooltips and autocomplete information in their IDEs when using the SDK.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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